diff --git a/src/apis/alertcenter/v1beta1.ts b/src/apis/alertcenter/v1beta1.ts index 2fddb1bbb6a..dc0e96bee1d 100644 --- a/src/apis/alertcenter/v1beta1.ts +++ b/src/apis/alertcenter/v1beta1.ts @@ -622,6 +622,10 @@ export namespace alertcenter_v1beta1 { * The header from display name. */ displayName?: string | null; + /** + * The actor who triggered a gmail phishing alert. + */ + entity?: Schema$User; /** * The sender email address. */ @@ -772,6 +776,19 @@ export namespace alertcenter_v1beta1 { */ customerId?: string | null; } + /** + * A user. + */ + export interface Schema$User { + /** + * Display name of the user. + */ + displayName?: string | null; + /** + * Email address of the user. + */ + emailAddress?: string | null; + } export class Resource$Alerts { context: APIRequestContext; diff --git a/src/apis/androidenterprise/v1.ts b/src/apis/androidenterprise/v1.ts index d2c1973e01d..0b86a0c39a3 100644 --- a/src/apis/androidenterprise/v1.ts +++ b/src/apis/androidenterprise/v1.ts @@ -148,9 +148,6 @@ export namespace androidenterprise_v1 { * A token authorizing an admin to access an iframe. */ export interface Schema$AdministratorWebToken { - /** - * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#administratorWebToken". - */ kind?: string | null; /** * An opaque token to be passed to the Play front-end to generate an iframe. @@ -161,9 +158,6 @@ export namespace androidenterprise_v1 { * Specification for a token used to generate iframes. The token specifies what data the admin is allowed to modify and the URI the iframe is allowed to communiate with. */ export interface Schema$AdministratorWebTokenSpec { - /** - * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#administratorWebTokenSpec". - */ kind?: string | null; /** * Options for displaying the Managed Configuration page. @@ -232,9 +226,6 @@ export namespace androidenterprise_v1 { * Represents the list of app restrictions available to be pre-configured for the product. */ export interface Schema$AppRestrictionsSchema { - /** - * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#appRestrictionsSchema". - */ kind?: string | null; /** * The set of restrictions that make up this schema. @@ -320,9 +311,6 @@ export namespace androidenterprise_v1 { * A URL that displays a product's permissions and that can also be used to approve the product with the Products.approve call. */ approvalUrl?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#approvalUrlInfo". - */ kind?: string | null; } /** @@ -376,9 +364,6 @@ export namespace androidenterprise_v1 { * An AuthenticationToken is used by the EMM's device policy client on a device to provision the given EMM-managed user on that device. */ export interface Schema$AuthenticationToken { - /** - * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#authenticationToken". - */ kind?: string | null; /** * The authentication token to be passed to the device policy client on the device where it can be used to provision the account for which this token was generated. @@ -416,7 +401,7 @@ export namespace androidenterprise_v1 { */ autoInstallPriority?: number | null; /** - * The minimum version of the app. If a lower version of the app is installed, then the app will be auto-updated according to the auto-install constraints, instead of waiting for the regular auto-update. + * The minimum version of the app. If a lower version of the app is installed, then the app will be auto-updated according to the auto-install constraints, instead of waiting for the regular auto-update. You can set a minimum version code for at most 20 apps per device. */ minimumVersionCode?: number | null; } @@ -424,9 +409,6 @@ export namespace androidenterprise_v1 { * A configuration variables resource contains the managed configuration settings ID to be applied to a single user, as well as the variable set that is attributed to the user. The variable set will be used to replace placeholders in the managed configuration settings. */ export interface Schema$ConfigurationVariables { - /** - * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#configurationVariables". - */ kind?: string | null; /** * The ID of the managed configurations settings. @@ -445,9 +427,6 @@ export namespace androidenterprise_v1 { * The Google Play Services Android ID for the device encoded as a lowercase hex string. For example, "123456789abcdef0". */ androidId?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#device". - */ kind?: string | null; /** * Identifies the extent to which the device is controlled by a managed Google Play EMM in various deployment configurations. Possible values include: - "managedDevice", a device that has the EMM's device policy controller (DPC) as the device owner. - "managedProfile", a device that has a profile managed by the DPC (DPC is profile owner) in addition to a separate, personal profile that is unavailable to the DPC. - "containerApp", no longer used (deprecated). - "unmanagedProfile", a device that has been allowed (by the domain's admin, using the Admin Console to enable the privilege) to use managed Google Play, but the profile is itself not owned by a DPC. @@ -513,9 +492,6 @@ export namespace androidenterprise_v1 { * The state of the Google account on the device. "enabled" indicates that the Google account on the device can be used to access Google services (including Google Play), while "disabled" means that it cannot. A new device is initially in the "disabled" state. */ accountState?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#deviceState". - */ kind?: string | null; } /** @@ -530,9 +506,6 @@ export namespace androidenterprise_v1 { * The unique ID for the enterprise. */ id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise". - */ kind?: string | null; /** * The name of the enterprise, for example, "Example, Inc". @@ -551,9 +524,6 @@ export namespace androidenterprise_v1 { * The email address of the service account. */ accountEmail?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterpriseAccount". - */ kind?: string | null; } /** @@ -583,9 +553,6 @@ export namespace androidenterprise_v1 { * The presence of an Entitlements resource indicates that a user has the right to use a particular app. Entitlements are user specific, not device specific. This allows a user with an entitlement to an app to install the app on all their devices. It's also possible for a user to hold an entitlement to an app without installing the app on any device. The API can be used to create an entitlement. As an option, you can also use the API to trigger the installation of an app on all a user's managed devices at the same time the entitlement is created. If the app is free, creating the entitlement also creates a group license for that app. For paid apps, creating the entitlement consumes one license, and that license remains consumed until the entitlement is removed. If the enterprise hasn't purchased enough licenses, then no entitlement is created and the installation fails. An entitlement is also not created for an app if the app requires permissions that the enterprise hasn't accepted. If an entitlement is deleted, the app may be uninstalled from a user's device. As a best practice, uninstall the app by calling Installs.delete() before deleting the entitlement. Entitlements for apps that a user pays for on an unmanaged profile have "userPurchase" as the entitlement reason. These entitlements cannot be removed via the API. */ export interface Schema$Entitlement { - /** - * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlement". - */ kind?: string | null; /** * The ID of the product that the entitlement is for. For example, "app:com.google.android.gm". @@ -621,9 +588,6 @@ export namespace androidenterprise_v1 { * Whether the product to which this group license relates is currently approved by the enterprise. Products are approved when a group license is first created, but this approval may be revoked by an enterprise admin via Google Play. Unapproved products will not be visible to end users in collections, and new entitlements to them should not normally be created. */ approval?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#groupLicense". - */ kind?: string | null; /** * The total number of provisioned licenses for this product. Returned by read operations, but ignored in write operations. @@ -676,9 +640,6 @@ export namespace androidenterprise_v1 { * Install state. The state "installPending" means that an install request has recently been made and download to the device is in progress. The state "installed" means that the app has been installed. This field is read-only. */ installState?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#install". - */ kind?: string | null; /** * The ID of the product that the install is for. For example, "app:com.google.android.gm". @@ -786,9 +747,6 @@ export namespace androidenterprise_v1 { * Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user. */ configurationVariables?: Schema$ConfigurationVariables; - /** - * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration". - */ kind?: string | null; /** * The set of managed properties for this configuration. @@ -829,9 +787,6 @@ export namespace androidenterprise_v1 { * A managed configurations settings resource contains the set of managed properties that have been configured for an Android app to be applied to a set of users. The app's developer would have defined configurable properties in the managed configurations schema. */ export interface Schema$ManagedConfigurationsSettings { - /** - * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfigurationsSettings". - */ kind?: string | null; /** * The last updated time of the managed configuration settings in milliseconds since 1970-01-01T00:00:00Z. @@ -992,9 +947,6 @@ export namespace androidenterprise_v1 { * A resource returned by the PullNotificationSet API, which contains a collection of notifications for enterprises associated with the service account authenticated for the request. */ export interface Schema$NotificationSet { - /** - * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#notificationSet". - */ kind?: string | null; /** * The notifications received, or empty if no notifications are present. @@ -1018,9 +970,6 @@ export namespace androidenterprise_v1 { * A longer description of the Permissions resource, giving more details of what it affects. */ description?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#permission". - */ kind?: string | null; /** * The name of the permission. @@ -1104,9 +1053,6 @@ export namespace androidenterprise_v1 { * A link to an image that can be used as an icon for the product. This image is suitable for use at up to 512px x 512px. */ iconUrl?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#product". - */ kind?: string | null; /** * The approximate time (within 7 days) the app was last published, expressed in milliseconds since epoch. @@ -1200,9 +1146,6 @@ export namespace androidenterprise_v1 { * Information about the permissions required by a specific app and whether they have been accepted by the enterprise. */ export interface Schema$ProductPermissions { - /** - * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productPermissions". - */ kind?: string | null; /** * The permissions required by the app. @@ -1252,9 +1195,6 @@ export namespace androidenterprise_v1 { * A set of products. */ export interface Schema$ProductSet { - /** - * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productSet". - */ kind?: string | null; /** * The list of product IDs making up the set of products. @@ -1331,9 +1271,6 @@ export namespace androidenterprise_v1 { * Credentials that can be used to authenticate as this ServiceAccount. */ key?: Schema$ServiceAccountKey; - /** - * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#serviceAccount". - */ kind?: string | null; /** * The account name of the service account, in the form of an email address. Assigned by the server. @@ -1352,9 +1289,6 @@ export namespace androidenterprise_v1 { * An opaque, unique identifier for this ServiceAccountKey. Assigned by the server. */ id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#serviceAccountKey". - */ kind?: string | null; /** * Public key data for the credentials file. This is an X.509 cert. If you are using the googleCredentials key type, this is identical to the cert that can be retrieved by using the X.509 cert url inside of the credentials file. @@ -1379,9 +1313,6 @@ export namespace androidenterprise_v1 { * An opaque token that will be required, along with the Enterprise Token, for obtaining the enterprise resource from CompleteSignup. */ completionToken?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#signupInfo". - */ kind?: string | null; /** * A URL under which the Admin can sign up for an enterprise. The page pointed to cannot be rendered in an iframe. @@ -1396,9 +1327,6 @@ export namespace androidenterprise_v1 { * Unique ID of this cluster. Assigned by the server. Immutable once assigned. */ id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster". - */ kind?: string | null; /** * Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry. @@ -1421,9 +1349,6 @@ export namespace androidenterprise_v1 { * The ID of the store page to be used as the homepage. The homepage is the first page shown in the managed Google Play Store. Not specifying a homepage is equivalent to setting the store layout type to "basic". */ homepageId?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeLayout". - */ kind?: string | null; /** * The store layout type. By default, this value is set to "basic" if the homepageId field is not set, and to "custom" otherwise. If set to "basic", the layout will consist of all approved apps that have been whitelisted for the user. @@ -1464,9 +1389,6 @@ export namespace androidenterprise_v1 { * Unique ID of this page. Assigned by the server. Immutable once assigned. */ id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storePage". - */ kind?: string | null; /** * Ordered list of pages a user should be able to reach from this page. The list can't include this page. It is recommended that the basic pages are created first, before adding the links between pages. The API doesn't verify that the pages exist or the pages are reachable. @@ -1514,9 +1436,6 @@ export namespace androidenterprise_v1 { * The unique ID for the user. */ id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user". - */ kind?: string | null; /** * The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge. @@ -1544,9 +1463,6 @@ export namespace androidenterprise_v1 { * A UserToken is used by a user when setting up a managed device or profile with their managed Google Play account on a device. When the user enters their email address and token (activation code) the appropriate EMM app can be automatically downloaded. */ export interface Schema$UserToken { - /** - * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#userToken". - */ kind?: string | null; /** * The token (activation code) to be entered by the user. This consists of a sequence of decimal digits. Note that the leading digit may be 0. @@ -1561,9 +1477,6 @@ export namespace androidenterprise_v1 { * A variable set is a key-value pair of EMM-provided placeholders and its corresponding value, which is attributed to a user. For example, $FIRSTNAME could be a placeholder, and its value could be Alice. Placeholders should start with a '$' sign and should be alphanumeric only. */ export interface Schema$VariableSet { - /** - * Identifies what kind of resource this is. Value: the fixed string "androidenterprise#variableSet". - */ kind?: string | null; /** * The placeholder string; defined by EMM. diff --git a/src/apis/androidmanagement/v1.ts b/src/apis/androidmanagement/v1.ts index e45da1d0243..6b881e3a913 100644 --- a/src/apis/androidmanagement/v1.ts +++ b/src/apis/androidmanagement/v1.ts @@ -117,6 +117,15 @@ export namespace androidmanagement_v1 { } } + /** + * Security policies set to the most secure values by default. To maintain the security posture of a device, we don't recommend overriding any of the default values. + */ + export interface Schema$AdvancedSecurityOverrides { + /** + * The policy for untrusted apps (apps from unknown sources) enforced on the device. Replaces install_unknown_sources_allowed (deprecated). + */ + untrustedAppsPolicy?: string | null; + } /** * Configuration for an always-on VPN connection. */ @@ -394,6 +403,23 @@ export namespace androidmanagement_v1 { */ packageNamesToDisable?: string[] | null; } + /** + * Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: A full date, with non-zero year, month and day values A month and day value, with a zero year, e.g. an anniversary A year on its own, with zero month and day values A year and month value, with a zero day, e.g. a credit card expiration dateRelated types are google.type.TimeOfDay and google.protobuf.Timestamp. + */ + export interface Schema$Date { + /** + * Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant. + */ + day?: number | null; + /** + * Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day. + */ + month?: number | null; + /** + * Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year. + */ + year?: number | null; + } /** * A device owned by an enterprise. Unless otherwise noted, all fields are read-only and can't be modified by enterprises.devices.patch. */ @@ -671,7 +697,7 @@ export namespace androidmanagement_v1 { */ pubsubTopic?: string | null; /** - * Sign-in details of the enterprise. Maximum of 1 SigninDetail is supported. + * Sign-in details of the enterprise. */ signinDetails?: Schema$SigninDetail[]; /** @@ -692,6 +718,19 @@ export namespace androidmanagement_v1 { */ url?: string | null; } + /** + * A system freeze period. When a device’s clock is within the freeze period, all incoming system updates (including security patches) are blocked and won’t be installed. When a device is outside the freeze period, normal update behavior applies. Leap years are ignored in freeze period calculations, in particular: * If Feb. 29th is set as the start or end date of a freeze period, the freeze period will start or end on Feb. 28th instead. * When a device’s system clock reads Feb. 29th, it’s treated as Feb. 28th. * When calculating the number of days in a freeze period or the time between two freeze periods, Feb. 29th is ignored and not counted as a day. + */ + export interface Schema$FreezePeriod { + /** + * The end date (inclusive) of the freeze period. Must be no later than 90 days from the start date. If the end date is earlier than the start date, the freeze period is considered wrapping year-end. Note: year must not be set. For example, {"month": 1,"date": 30}. + */ + endDate?: Schema$Date; + /** + * The start date (inclusive) of the freeze period. Note: year must not be set. For example, {"month": 1,"date": 30}. + */ + startDate?: Schema$Date; + } /** * Information about device hardware. The fields related to temperature thresholds are only available if hardwareStatusEnabled is true in the device's policy. */ @@ -815,6 +854,27 @@ export namespace androidmanagement_v1 { */ severity?: string | null; } + /** + * Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, set kioskCustomLauncherEnabled to true or specify an app in the policy with installType KIOSK. + */ + export interface Schema$KioskCustomization { + /** + * Sets the behavior of a device in kiosk mode when a user presses and holds (long-presses) the Power button. + */ + powerButtonActions?: string | null; + /** + * Specifies whether system info and notifications are disabled in kiosk mode. + */ + statusBar?: string | null; + /** + * Specifies whether system error dialogs for crashed or unresponsive apps are blocked in kiosk mode. When blocked, the system will force-stop the app as if the user chooses the "close app" option on the UI. + */ + systemErrorWarnings?: string | null; + /** + * Specifies which navigation features are enabled (e.g. Home, Overview buttons) in kiosk mode. + */ + systemNavigation?: string | null; + } /** * An action to launch an app. */ @@ -1118,6 +1178,10 @@ export namespace androidmanagement_v1 { * The scope that the password requirement applies to. */ passwordScope?: string | null; + /** + * The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile. + */ + requirePasswordUnlock?: string | null; } /** * Configuration for an Android permission and its grant state. @@ -1165,6 +1229,10 @@ export namespace androidmanagement_v1 { * Whether adjusting the master volume is disabled. */ adjustVolumeDisabled?: boolean | null; + /** + * Security policies set to the most secure values by default. To maintain the security posture of a device, we don't recommend overriding any of the default values. + */ + advancedSecurityOverrides?: Schema$AdvancedSecurityOverrides; /** * Configuration for an always-on VPN connection. Use with vpn_config_disabled to prevent modification of this setting. */ @@ -1277,6 +1345,10 @@ export namespace androidmanagement_v1 { * Disabled keyguard customizations, such as widgets. */ keyguardDisabledFeatures?: string[] | null; + /** + * Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, set kioskCustomLauncherEnabled to true or specify an app in the policy with installType KIOSK. + */ + kioskCustomization?: Schema$KioskCustomization; /** * Whether the kiosk custom launcher is enabled. This replaces the home screen with a launcher that locks down the device to the apps installed via the applications setting. Apps appear on a single page in alphabetical order. The status bar is disabled when this is set. */ @@ -1402,7 +1474,7 @@ export namespace androidmanagement_v1 { */ shareLocationDisabled?: boolean | null; /** - * A message displayed to the user in the settings screen wherever functionality has been disabled by the admin. + * A message displayed to the user in the settings screen wherever functionality has been disabled by the admin. If the message is longer than 200 characters it may be truncated. */ shortSupportMessage?: Schema$UserFacingMessage; /** @@ -1673,11 +1745,11 @@ export namespace androidmanagement_v1 { */ deviceSettingsEnabled?: boolean | null; /** - * Whether displays reporting is enabled. + * Whether displays reporting is enabled. Report data is not available for personally owned devices with work profiles. */ displayInfoEnabled?: boolean | null; /** - * Whether hardware status reporting is enabled. + * Whether hardware status reporting is enabled. Report data is not available for personally owned devices with work profiles. */ hardwareStatusEnabled?: boolean | null; /** @@ -1689,7 +1761,7 @@ export namespace androidmanagement_v1 { */ networkInfoEnabled?: boolean | null; /** - * Whether power management event reporting is enabled. + * Whether power management event reporting is enabled. Report data is not available for personally owned devices with work profiles. */ powerManagementEventsEnabled?: boolean | null; /** @@ -1709,6 +1781,10 @@ export namespace androidmanagement_v1 { * If the type is WINDOWED, the end of the maintenance window, measured as the number of minutes after midnight in device's local time. This value must be between 0 and 1439, inclusive. If this value is less than start_minutes, then the maintenance window spans midnight. If the maintenance window specified is smaller than 30 minutes, the actual window is extended to 30 minutes beyond the start time. */ endMinutes?: number | null; + /** + * An annually repeating time period in which over-the-air (OTA) system updates are postponed to freeze the OS version running on a device. To prevent freezing the device indefinitely, each freeze period must be separated by at least 60 days. + */ + freezePeriods?: Schema$FreezePeriod[]; /** * If the type is WINDOWED, the start of the maintenance window, measured as the number of minutes after midnight in the device's local time. This value must be between 0 and 1439, inclusive. */ @@ -2245,6 +2321,7 @@ export namespace androidmanagement_v1 { * @param {object} params Parameters for request * @param {string} params.name The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}. * @param {string=} params.wipeDataFlags Optional flags that control the device wiping behavior. + * @param {string=} params.wipeReasonMessage Optional short message displayed to the user before wiping the work profile on personal devices. This has no effect on company owned devices. The maximum message length is 200 characters. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2618,6 +2695,10 @@ export namespace androidmanagement_v1 { * Optional flags that control the device wiping behavior. */ wipeDataFlags?: string[]; + /** + * Optional short message displayed to the user before wiping the work profile on personal devices. This has no effect on company owned devices. The maximum message length is 200 characters. + */ + wipeReasonMessage?: string; } export interface Params$Resource$Enterprises$Devices$Get extends StandardParameters { diff --git a/src/apis/androidpublisher/v3.ts b/src/apis/androidpublisher/v3.ts index 693194b43ca..360a9c0ef8b 100644 --- a/src/apis/androidpublisher/v3.ts +++ b/src/apis/androidpublisher/v3.ts @@ -93,6 +93,7 @@ export namespace androidpublisher_v3 { orders: Resource$Orders; purchases: Resource$Purchases; reviews: Resource$Reviews; + systemapks: Resource$Systemapks; constructor(options: GlobalOptions, google?: GoogleConfigurable) { this.context = { @@ -108,6 +109,7 @@ export namespace androidpublisher_v3 { this.orders = new Resource$Orders(this.context); this.purchases = new Resource$Purchases(this.context); this.reviews = new Resource$Reviews(this.context); + this.systemapks = new Resource$Systemapks(this.context); } } @@ -291,6 +293,11 @@ export namespace androidpublisher_v3 { */ screenWidthPx?: number | null; } + export interface Schema$DeviceSpec { + screenDensity?: number | null; + supportedAbis?: string[] | null; + supportedLocales?: string[] | null; + } export interface Schema$ExpansionFile { /** * If set this field indicates that this APK has an Expansion File uploaded to it: this APK does not reference another APK's Expansion File. The field's value is the size of the uploaded Expansion File in bytes. @@ -546,11 +553,6 @@ export namespace androidpublisher_v3 { */ text?: string | null; } - export interface Schema$MendelSampling { - modRanges?: Schema$ModRange[]; - modulus?: string | null; - salt?: number | null; - } export interface Schema$ModRange { end?: string | null; start?: string | null; @@ -624,6 +626,10 @@ export namespace androidpublisher_v3 { * The type of purchase of the inapp product. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: - Test (i.e. purchased from a license testing account) - Promo (i.e. purchased using a promo code) - Rewarded (i.e. from watching a video ad instead of paying) */ purchaseType?: number | null; + /** + * The quantity associated with the purchase of the inapp product. + */ + quantity?: number | null; } export interface Schema$ProductPurchasesAcknowledgeRequest { /** @@ -679,6 +685,11 @@ export namespace androidpublisher_v3 { export interface Schema$ReviewsReplyResponse { result?: Schema$ReviewReplyResult; } + export interface Schema$Sampling { + modRanges?: Schema$ModRange[]; + modulus?: string | null; + salt?: number | null; + } export interface Schema$Season { /** * Inclusive end date of the recurrence period. @@ -851,6 +862,12 @@ export namespace androidpublisher_v3 { */ newExpiryTimeMillis?: string | null; } + export interface Schema$SystemApkVariantsCreateRequest { + deviceSpec?: Schema$DeviceSpec; + } + export interface Schema$SystemApkVariantsListResponse { + variants?: Schema$Variant[]; + } export interface Schema$Testers { /** * A list of all Google Groups, as email addresses, that define testers for this track. @@ -886,7 +903,7 @@ export namespace androidpublisher_v3 { * The description of what is new in the app in this release. */ releaseNotes?: Schema$LocalizedText[]; - sampling?: Schema$MendelSampling; + sampling?: Schema$Sampling; /** * The desired status of this release. */ @@ -957,6 +974,13 @@ export namespace androidpublisher_v3 { */ thumbsUpCount?: number | null; } + /** + * Represents the variant of a generated system APK from an uploaded App Bundle. + */ + export interface Schema$Variant { + deviceSpec?: Schema$DeviceSpec; + variantId?: number | null; + } /** * A VoidedPurchase resource indicates a purchase that was either canceled/refunded/charged-back. */ @@ -6830,4 +6854,404 @@ export namespace androidpublisher_v3 { */ requestBody?: Schema$ReviewsReplyRequest; } + + export class Resource$Systemapks { + context: APIRequestContext; + variants: Resource$Systemapks$Variants; + constructor(context: APIRequestContext) { + this.context = context; + this.variants = new Resource$Systemapks$Variants(this.context); + } + } + + export class Resource$Systemapks$Variants { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * androidpublisher.systemapks.variants.create + * @desc Creates a new variant of APK which is suitable for inclusion in a system image. + * @alias androidpublisher.systemapks.variants.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.packageName Unique identifier for the Android app; for example, "com.spiffygame". + * @param {string} params.versionCode The version code of the App Bundle. + * @param {().SystemApkVariantsCreateRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params?: Params$Resource$Systemapks$Variants$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Systemapks$Variants$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Systemapks$Variants$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Systemapks$Variants$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Systemapks$Variants$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Systemapks$Variants$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/androidpublisher/v3/applications/{packageName}/systemApks/{versionCode}/variants' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['packageName', 'versionCode'], + pathParams: ['packageName', 'versionCode'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * androidpublisher.systemapks.variants.download + * @desc Download a previously created APK which is suitable for inclusion in a system image. + * @alias androidpublisher.systemapks.variants.download + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.packageName Unique identifier for the Android app; for example, "com.spiffygame". + * @param {integer} params.variantId + * @param {string} params.versionCode The version code of the App Bundle. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + download( + params?: Params$Resource$Systemapks$Variants$Download, + options?: MethodOptions + ): GaxiosPromise; + download( + params: Params$Resource$Systemapks$Variants$Download, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + download( + params: Params$Resource$Systemapks$Variants$Download, + callback: BodyResponseCallback + ): void; + download(callback: BodyResponseCallback): void; + download( + paramsOrCallback?: + | Params$Resource$Systemapks$Variants$Download + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Systemapks$Variants$Download; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Systemapks$Variants$Download; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/androidpublisher/v3/applications/{packageName}/systemApks/{versionCode}/variants/{variantId}:download' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['packageName', 'versionCode', 'variantId'], + pathParams: ['packageName', 'variantId', 'versionCode'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * androidpublisher.systemapks.variants.get + * @desc Returns a previously created system APK variant. + * @alias androidpublisher.systemapks.variants.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.packageName Unique identifier for the Android app; for example, "com.spiffygame". + * @param {integer} params.variantId Unique identifier for this variant. + * @param {string} params.versionCode The version code of the App Bundle. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Systemapks$Variants$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Systemapks$Variants$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Systemapks$Variants$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Systemapks$Variants$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Systemapks$Variants$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Systemapks$Variants$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/androidpublisher/v3/applications/{packageName}/systemApks/{versionCode}/variants/{variantId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['packageName', 'versionCode', 'variantId'], + pathParams: ['packageName', 'variantId', 'versionCode'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * androidpublisher.systemapks.variants.list + * @desc Returns the list of previously created system APK variants. + * @alias androidpublisher.systemapks.variants.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.packageName Unique identifier for the Android app; for example, "com.spiffygame". + * @param {string} params.versionCode The version code of the App Bundle. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Systemapks$Variants$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Systemapks$Variants$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Systemapks$Variants$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Systemapks$Variants$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Systemapks$Variants$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Systemapks$Variants$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/androidpublisher/v3/applications/{packageName}/systemApks/{versionCode}/variants' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['packageName', 'versionCode'], + pathParams: ['packageName', 'versionCode'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Systemapks$Variants$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Unique identifier for the Android app; for example, "com.spiffygame". + */ + packageName?: string; + /** + * The version code of the App Bundle. + */ + versionCode?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SystemApkVariantsCreateRequest; + } + export interface Params$Resource$Systemapks$Variants$Download + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Unique identifier for the Android app; for example, "com.spiffygame". + */ + packageName?: string; + /** + * + */ + variantId?: number; + /** + * The version code of the App Bundle. + */ + versionCode?: string; + } + export interface Params$Resource$Systemapks$Variants$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Unique identifier for the Android app; for example, "com.spiffygame". + */ + packageName?: string; + /** + * Unique identifier for this variant. + */ + variantId?: number; + /** + * The version code of the App Bundle. + */ + versionCode?: string; + } + export interface Params$Resource$Systemapks$Variants$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Unique identifier for the Android app; for example, "com.spiffygame". + */ + packageName?: string; + /** + * The version code of the App Bundle. + */ + versionCode?: string; + } } diff --git a/src/apis/bigquery/v2.ts b/src/apis/bigquery/v2.ts index a723fc91a65..64de4d13084 100644 --- a/src/apis/bigquery/v2.ts +++ b/src/apis/bigquery/v2.ts @@ -416,15 +416,15 @@ export namespace bigquery_v2 { * [Output-only, Beta] Training options used by this training run. These options are mutable for subsequent training runs. Default values are explicitly stored for options not specified in the input query of the first training run. For subsequent training runs, any option not explicitly specified in the input query will be copied from the previous training run. */ trainingOptions?: { - l2Reg?: number; - warmStart?: boolean; - learnRateStrategy?: string; lineSearchInitLearnRate?: number; earlyStop?: boolean; l1Reg?: number; maxIteration?: string; learnRate?: number; minRelProgress?: number; + l2Reg?: number; + learnRateStrategy?: string; + warmStart?: boolean; } | null; } /** @@ -550,13 +550,13 @@ export namespace bigquery_v2 { * [Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; */ access?: Array<{ - role?: string; - view?: Schema$TableReference; - groupByEmail?: string; - userByEmail?: string; domain?: string; + userByEmail?: string; iamMember?: string; specialGroup?: string; + role?: string; + view?: Schema$TableReference; + groupByEmail?: string; }> | null; /** * [Output-only] The time when this dataset was created, in milliseconds since the epoch. @@ -805,6 +805,10 @@ export namespace bigquery_v2 { * Total number of bytes written to shuffle and spilled to disk. */ shuffleOutputBytesSpilled?: string | null; + /** + * Slot-milliseconds used by the stage. + */ + slotMs?: string | null; /** * Stage start time represented as milliseconds since epoch. */ @@ -1397,8 +1401,8 @@ export namespace bigquery_v2 { */ jobs?: Array<{ user_email?: string; - kind?: string; errorResult?: Schema$ErrorProto; + kind?: string; jobReference?: Schema$JobReference; status?: Schema$JobStatus; state?: string; @@ -1547,7 +1551,7 @@ export namespace bigquery_v2 { /** * [Output-only] Job resource usage breakdown by reservation. */ - reservationUsage?: Array<{name?: string; slotMs?: string}> | null; + reservationUsage?: Array<{slotMs?: string; name?: string}> | null; /** * [Output-only] The schema of the results. Present only for successful dry run of non-legacy SQL queries. */ @@ -1693,7 +1697,7 @@ export namespace bigquery_v2 { */ description?: string | null; /** - * Custom encryption configuration (e.g., Cloud KMS keys). This shows the encryption configuration of the model data while stored in BigQuery storage. + * Custom encryption configuration (e.g., Cloud KMS keys). This shows the encryption configuration of the model data while stored in BigQuery storage. This field can be used with PatchModel to update encryption key for an already encrypted model. */ encryptionConfiguration?: Schema$EncryptionConfiguration; /** @@ -1988,7 +1992,7 @@ export namespace bigquery_v2 { /** * [TrustedTester] [Required] Defines the ranges for range partitioning. */ - range?: {interval?: string; start?: string; end?: string} | null; + range?: {start?: string; end?: string; interval?: string} | null; } /** * Evaluation metrics for regression and explicit feedback type matrix factorization models. @@ -2389,18 +2393,18 @@ export namespace bigquery_v2 { * Tables in the requested dataset. */ tables?: Array<{ - id?: string; - tableReference?: Schema$TableReference; - friendlyName?: string; - timePartitioning?: Schema$TimePartitioning; - labels?: {[key: string]: string}; - clustering?: Schema$Clustering; type?: string; + clustering?: Schema$Clustering; expirationTime?: string; kind?: string; view?: {useLegacySql?: boolean}; creationTime?: string; rangePartitioning?: Schema$RangePartitioning; + id?: string; + tableReference?: Schema$TableReference; + friendlyName?: string; + timePartitioning?: Schema$TimePartitioning; + labels?: {[key: string]: string}; }> | null; /** * The total number of tables in the dataset. @@ -5501,6 +5505,7 @@ export namespace bigquery_v2 { * @param {object} params Parameters for request * @param {string} params.datasetId Required. Dataset ID of the requested routine * @param {string} params.projectId Required. Project ID of the requested routine + * @param {string=} params.readMask If set, only the Routine fields in the field mask are returned in the response. If unset, all Routine fields are returned. * @param {string} params.routineId Required. Routine ID of the requested routine * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5761,9 +5766,11 @@ export namespace bigquery_v2 { * * @param {object} params Parameters for request * @param {string} params.datasetId Required. Dataset ID of the routines to list + * @param {string=} params.filter If set, then only the Routines matching this filter are returned. The current supported form is either "routine_type:" or "routineType:", where is a RoutineType enum. Example: "routineType:SCALAR_FUNCTION". * @param {integer=} params.maxResults The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection. * @param {string=} params.pageToken Page token, returned by a previous call, to request the next page of results * @param {string} params.projectId Required. Project ID of the routines to list + * @param {string=} params.readMask If set, then only the Routine fields in the field mask, as well as project_id, dataset_id and routine_id, are returned in the response. If unset, then the following Routine fields are returned: etag, project_id, dataset_id, routine_id, routine_type, creation_time, last_modified_time, and language. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5996,6 +6003,10 @@ export namespace bigquery_v2 { * Required. Project ID of the requested routine */ projectId?: string; + /** + * If set, only the Routine fields in the field mask are returned in the response. If unset, all Routine fields are returned. + */ + readMask?: string; /** * Required. Routine ID of the requested routine */ @@ -6031,6 +6042,10 @@ export namespace bigquery_v2 { * Required. Dataset ID of the routines to list */ datasetId?: string; + /** + * If set, then only the Routines matching this filter are returned. The current supported form is either "routine_type:" or "routineType:", where is a RoutineType enum. Example: "routineType:SCALAR_FUNCTION". + */ + filter?: string; /** * The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection. */ @@ -6043,6 +6058,10 @@ export namespace bigquery_v2 { * Required. Project ID of the routines to list */ projectId?: string; + /** + * If set, then only the Routine fields in the field mask, as well as project_id, dataset_id and routine_id, are returned in the response. If unset, then the following Routine fields are returned: etag, project_id, dataset_id, routine_id, routine_type, creation_time, last_modified_time, and language. + */ + readMask?: string; } export interface Params$Resource$Routines$Update extends StandardParameters { /** diff --git a/src/apis/bigqueryconnection/v1beta1.ts b/src/apis/bigqueryconnection/v1beta1.ts index 85cee015d45..80fbb047732 100644 --- a/src/apis/bigqueryconnection/v1beta1.ts +++ b/src/apis/bigqueryconnection/v1beta1.ts @@ -150,7 +150,7 @@ export namespace bigqueryconnection_v1beta1 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -175,6 +175,10 @@ export namespace bigqueryconnection_v1beta1 { * Connection properties specific to the Cloud SQL. */ export interface Schema$CloudSqlProperties { + /** + * Input only. Cloud SQL credential. + */ + credential?: Schema$CloudSqlCredential; /** * Database name. */ @@ -287,7 +291,7 @@ export namespace bigqueryconnection_v1beta1 { nextPageToken?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -295,15 +299,15 @@ export namespace bigqueryconnection_v1beta1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if the incoming policy version does not meet the requirements for modifying the stored policy. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a binding (conditional or unconditional) from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, version compliance checks against the stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } @@ -373,7 +377,7 @@ export namespace bigqueryconnection_v1beta1 { * * @param {object} params Parameters for request * @param {string=} params.connectionId Optional. Connection id that should be assigned to the created connection. - * @param {string} params.parent Parent resource name. Must be in the format `projects/{project_id}/locations/{location_id}` + * @param {string} params.parent Required. Parent resource name. Must be in the format `projects/{project_id}/locations/{location_id}` * @param {().Connection} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -449,7 +453,7 @@ export namespace bigqueryconnection_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Name of the deleted connection, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}` + * @param {string} params.name Required. Name of the deleted connection, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -519,7 +523,7 @@ export namespace bigqueryconnection_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Name of the requested connection, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}` + * @param {string} params.name Required. Name of the requested connection, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -665,9 +669,9 @@ export namespace bigqueryconnection_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.maxResults Maximum number of results per page. + * @param {integer=} params.maxResults Required. Maximum number of results per page. * @param {string=} params.pageToken Page token. - * @param {string} params.parent Parent resource name. Must be in the form: `projects/{project_id}/locations/{location_id}` + * @param {string} params.parent Required. Parent resource name. Must be in the form: `projects/{project_id}/locations/{location_id}` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -744,8 +748,8 @@ export namespace bigqueryconnection_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Name of the connection to update, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}` - * @param {string=} params.updateMask Update mask for the connection fields to be updated. + * @param {string} params.name Required. Name of the connection to update, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}` + * @param {string=} params.updateMask Required. Update mask for the connection fields to be updated. * @param {().Connection} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -975,7 +979,7 @@ export namespace bigqueryconnection_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Name of the connection, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}/credential` + * @param {string} params.name Required. Name of the connection, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}/credential` * @param {().ConnectionCredential} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1052,7 +1056,7 @@ export namespace bigqueryconnection_v1beta1 { */ connectionId?: string; /** - * Parent resource name. Must be in the format `projects/{project_id}/locations/{location_id}` + * Required. Parent resource name. Must be in the format `projects/{project_id}/locations/{location_id}` */ parent?: string; @@ -1069,7 +1073,7 @@ export namespace bigqueryconnection_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the deleted connection, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}` + * Required. Name of the deleted connection, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}` */ name?: string; } @@ -1081,7 +1085,7 @@ export namespace bigqueryconnection_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the requested connection, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}` + * Required. Name of the requested connection, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}` */ name?: string; } @@ -1110,7 +1114,7 @@ export namespace bigqueryconnection_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Maximum number of results per page. + * Required. Maximum number of results per page. */ maxResults?: number; /** @@ -1118,7 +1122,7 @@ export namespace bigqueryconnection_v1beta1 { */ pageToken?: string; /** - * Parent resource name. Must be in the form: `projects/{project_id}/locations/{location_id}` + * Required. Parent resource name. Must be in the form: `projects/{project_id}/locations/{location_id}` */ parent?: string; } @@ -1130,11 +1134,11 @@ export namespace bigqueryconnection_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the connection to update, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}` + * Required. Name of the connection to update, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}` */ name?: string; /** - * Update mask for the connection fields to be updated. + * Required. Update mask for the connection fields to be updated. */ updateMask?: string; @@ -1185,7 +1189,7 @@ export namespace bigqueryconnection_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the connection, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}/credential` + * Required. Name of the connection, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}/credential` */ name?: string; diff --git a/src/apis/bigquerydatatransfer/v1.ts b/src/apis/bigquerydatatransfer/v1.ts index cc88e31df1f..bf2111384b2 100644 --- a/src/apis/bigquerydatatransfer/v1.ts +++ b/src/apis/bigquerydatatransfer/v1.ts @@ -623,7 +623,7 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The data source in the form: `projects/{project_id}/dataSources/{data_source_id}` + * @param {string} params.name Required. The data source in the form: `projects/{project_id}/dataSources/{data_source_id}` or `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`. * @param {().CheckValidCredsRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -703,7 +703,7 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}` + * @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}` or `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -777,7 +777,7 @@ export namespace bigquerydatatransfer_v1 { * @param {object} params Parameters for request * @param {integer=} params.pageSize Page size. The default page size is the maximum value of 1000 results. * @param {string=} params.pageToken Pagination token, which can be used to request a specific page of `ListDataSourcesRequest` list results. For multiple-page results, `ListDataSourcesResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. - * @param {string} params.parent Required. The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` + * @param {string} params.parent Required. The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` or `projects/{project_id}/locations/{location_id} * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -856,7 +856,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The data source in the form: `projects/{project_id}/dataSources/{data_source_id}` + * Required. The data source in the form: `projects/{project_id}/dataSources/{data_source_id}` or `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`. */ name?: string; @@ -873,7 +873,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}` + * Required. The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}` or `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}` */ name?: string; } @@ -893,7 +893,7 @@ export namespace bigquerydatatransfer_v1 { */ pageToken?: string; /** - * Required. The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` + * Required. The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` or `projects/{project_id}/locations/{location_id} */ parent?: string; } @@ -1113,7 +1113,7 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The data source in the form: `projects/{project_id}/dataSources/{data_source_id}` + * @param {string} params.name Required. The data source in the form: `projects/{project_id}/dataSources/{data_source_id}` or `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`. * @param {().CheckValidCredsRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1193,7 +1193,7 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}` + * @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}` or `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1267,7 +1267,7 @@ export namespace bigquerydatatransfer_v1 { * @param {object} params Parameters for request * @param {integer=} params.pageSize Page size. The default page size is the maximum value of 1000 results. * @param {string=} params.pageToken Pagination token, which can be used to request a specific page of `ListDataSourcesRequest` list results. For multiple-page results, `ListDataSourcesResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. - * @param {string} params.parent Required. The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` + * @param {string} params.parent Required. The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` or `projects/{project_id}/locations/{location_id} * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1346,7 +1346,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The data source in the form: `projects/{project_id}/dataSources/{data_source_id}` + * Required. The data source in the form: `projects/{project_id}/dataSources/{data_source_id}` or `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`. */ name?: string; @@ -1363,7 +1363,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}` + * Required. The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}` or `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}` */ name?: string; } @@ -1383,7 +1383,7 @@ export namespace bigquerydatatransfer_v1 { */ pageToken?: string; /** - * Required. The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` + * Required. The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` or `projects/{project_id}/locations/{location_id} */ parent?: string; } @@ -1406,7 +1406,7 @@ export namespace bigquerydatatransfer_v1 { * * @param {object} params Parameters for request * @param {string=} params.authorizationCode Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. - * @param {string} params.parent Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} If specified location and location of the destination bigquery dataset do not match - the request will fail. + * @param {string} params.parent Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail. * @param {string=} params.serviceAccountName Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account. * @param {string=} params.versionInfo Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request. * @param {().TransferConfig} params.requestBody Request body data @@ -1484,7 +1484,7 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` + * @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1554,7 +1554,7 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` + * @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1629,7 +1629,7 @@ export namespace bigquerydatatransfer_v1 { * @param {string=} params.dataSourceIds When specified, only configurations of requested data sources are returned. * @param {integer=} params.pageSize Page size. The default page size is the maximum value of 1000 results. * @param {string=} params.pageToken Pagination token, which can be used to request a specific page of `ListTransfersRequest` list results. For multiple-page results, `ListTransfersResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. - * @param {string} params.parent Required. The BigQuery project id for which data sources should be returned: `projects/{project_id}`. + * @param {string} params.parent Required. The BigQuery project id for which data sources should be returned: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1788,7 +1788,7 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}`. + * @param {string} params.parent Required. Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. * @param {().ScheduleTransferRunsRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1873,7 +1873,7 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}`. + * @param {string} params.parent Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. * @param {().StartManualTransferRunsRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1964,7 +1964,7 @@ export namespace bigquerydatatransfer_v1 { */ authorizationCode?: string; /** - * Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} If specified location and location of the destination bigquery dataset do not match - the request will fail. + * Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail. */ parent?: string; /** @@ -1989,7 +1989,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` + * Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}` */ name?: string; } @@ -2001,7 +2001,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` + * Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}` */ name?: string; } @@ -2025,7 +2025,7 @@ export namespace bigquerydatatransfer_v1 { */ pageToken?: string; /** - * Required. The BigQuery project id for which data sources should be returned: `projects/{project_id}`. + * Required. The BigQuery project id for which data sources should be returned: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}` */ parent?: string; } @@ -2070,7 +2070,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}`. + * Required. Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. */ parent?: string; @@ -2087,7 +2087,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}`. + * Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. */ parent?: string; @@ -2114,7 +2114,7 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` + * @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2184,7 +2184,7 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` + * @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2258,7 +2258,7 @@ export namespace bigquerydatatransfer_v1 { * @param {object} params Parameters for request * @param {integer=} params.pageSize Page size. The default page size is the maximum value of 1000 results. * @param {string=} params.pageToken Pagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results. For multiple-page results, `ListTransferRunsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. - * @param {string} params.parent Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}`. + * @param {string} params.parent Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. * @param {string=} params.runAttempt Indicates how run attempts are to be pulled. * @param {string=} params.states When specified, only transfer runs with requested states are returned. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2336,7 +2336,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` + * Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` */ name?: string; } @@ -2348,7 +2348,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` + * Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` */ name?: string; } @@ -2368,7 +2368,7 @@ export namespace bigquerydatatransfer_v1 { */ pageToken?: string; /** - * Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}`. + * Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. */ parent?: string; /** @@ -2397,7 +2397,7 @@ export namespace bigquerydatatransfer_v1 { * @param {string=} params.messageTypes Message types to return. If not populated - INFO, WARNING and ERROR messages are returned. * @param {integer=} params.pageSize Page size. The default page size is the maximum value of 1000 results. * @param {string=} params.pageToken Pagination token, which can be used to request a specific page of `ListTransferLogsRequest` list results. For multiple-page results, `ListTransferLogsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. - * @param {string} params.parent Required. Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`. + * @param {string} params.parent Required. Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2488,7 +2488,7 @@ export namespace bigquerydatatransfer_v1 { */ pageToken?: string; /** - * Required. Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`. + * Required. Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` */ parent?: string; } @@ -2509,7 +2509,7 @@ export namespace bigquerydatatransfer_v1 { * * @param {object} params Parameters for request * @param {string=} params.authorizationCode Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. - * @param {string} params.parent Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} If specified location and location of the destination bigquery dataset do not match - the request will fail. + * @param {string} params.parent Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail. * @param {string=} params.serviceAccountName Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account. * @param {string=} params.versionInfo Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request. * @param {().TransferConfig} params.requestBody Request body data @@ -2587,7 +2587,7 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` + * @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2657,7 +2657,7 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` + * @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2732,7 +2732,7 @@ export namespace bigquerydatatransfer_v1 { * @param {string=} params.dataSourceIds When specified, only configurations of requested data sources are returned. * @param {integer=} params.pageSize Page size. The default page size is the maximum value of 1000 results. * @param {string=} params.pageToken Pagination token, which can be used to request a specific page of `ListTransfersRequest` list results. For multiple-page results, `ListTransfersResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. - * @param {string} params.parent Required. The BigQuery project id for which data sources should be returned: `projects/{project_id}`. + * @param {string} params.parent Required. The BigQuery project id for which data sources should be returned: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2891,7 +2891,7 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}`. + * @param {string} params.parent Required. Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. * @param {().ScheduleTransferRunsRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2976,7 +2976,7 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}`. + * @param {string} params.parent Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. * @param {().StartManualTransferRunsRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3067,7 +3067,7 @@ export namespace bigquerydatatransfer_v1 { */ authorizationCode?: string; /** - * Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} If specified location and location of the destination bigquery dataset do not match - the request will fail. + * Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail. */ parent?: string; /** @@ -3092,7 +3092,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` + * Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}` */ name?: string; } @@ -3104,7 +3104,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` + * Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}` */ name?: string; } @@ -3128,7 +3128,7 @@ export namespace bigquerydatatransfer_v1 { */ pageToken?: string; /** - * Required. The BigQuery project id for which data sources should be returned: `projects/{project_id}`. + * Required. The BigQuery project id for which data sources should be returned: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}` */ parent?: string; } @@ -3173,7 +3173,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}`. + * Required. Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. */ parent?: string; @@ -3190,7 +3190,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}`. + * Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. */ parent?: string; @@ -3217,7 +3217,7 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` + * @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3287,7 +3287,7 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` + * @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3361,7 +3361,7 @@ export namespace bigquerydatatransfer_v1 { * @param {object} params Parameters for request * @param {integer=} params.pageSize Page size. The default page size is the maximum value of 1000 results. * @param {string=} params.pageToken Pagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results. For multiple-page results, `ListTransferRunsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. - * @param {string} params.parent Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}`. + * @param {string} params.parent Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. * @param {string=} params.runAttempt Indicates how run attempts are to be pulled. * @param {string=} params.states When specified, only transfer runs with requested states are returned. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3439,7 +3439,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` + * Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` */ name?: string; } @@ -3451,7 +3451,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` + * Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` */ name?: string; } @@ -3471,7 +3471,7 @@ export namespace bigquerydatatransfer_v1 { */ pageToken?: string; /** - * Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}`. + * Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. */ parent?: string; /** @@ -3500,7 +3500,7 @@ export namespace bigquerydatatransfer_v1 { * @param {string=} params.messageTypes Message types to return. If not populated - INFO, WARNING and ERROR messages are returned. * @param {integer=} params.pageSize Page size. The default page size is the maximum value of 1000 results. * @param {string=} params.pageToken Pagination token, which can be used to request a specific page of `ListTransferLogsRequest` list results. For multiple-page results, `ListTransferLogsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. - * @param {string} params.parent Required. Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`. + * @param {string} params.parent Required. Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3591,7 +3591,7 @@ export namespace bigquerydatatransfer_v1 { */ pageToken?: string; /** - * Required. Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`. + * Required. Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` */ parent?: string; } diff --git a/src/apis/bigqueryreservation/v1alpha2.ts b/src/apis/bigqueryreservation/v1alpha2.ts index 07cd2848451..44e1efa8f38 100644 --- a/src/apis/bigqueryreservation/v1alpha2.ts +++ b/src/apis/bigqueryreservation/v1alpha2.ts @@ -238,6 +238,10 @@ export namespace bigqueryreservation_v1alpha2 { * Resource name of the reservation. E.g., projects/myproject/locations/eu/reservations/my_reservation. This reservation must be in the same location as the grant. This reservation should belong to the same parent project. */ reservation?: string | null; + /** + * Output only. State of the ReservationGrant. + */ + state?: string | null; } /** * The response for ReservationService.SearchReservationGrants. diff --git a/src/apis/bigqueryreservation/v1beta1.ts b/src/apis/bigqueryreservation/v1beta1.ts index c6d10529a66..d8795b9a312 100644 --- a/src/apis/bigqueryreservation/v1beta1.ts +++ b/src/apis/bigqueryreservation/v1beta1.ts @@ -131,6 +131,10 @@ export namespace bigqueryreservation_v1beta1 { * Output only. Name of the resource. E.g.: projects/myproject/locations/US/reservations/team1-prod/assignments/123. */ name?: string | null; + /** + * Output only. State of the assignment. + */ + state?: string | null; } /** * Represents a BI Reservation. @@ -841,6 +845,7 @@ export namespace bigqueryreservation_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request + * @param {boolean=} params.enforceSingleAdminProjectPerOrg If true, fail the request if another project in the organization has a capacity commitment. * @param {string} params.parent Resource name of the parent reservation. E.g., projects/myproject/locations/US * @param {().CapacityCommitment} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1146,6 +1151,10 @@ export namespace bigqueryreservation_v1beta1 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * If true, fail the request if another project in the organization has a capacity commitment. + */ + enforceSingleAdminProjectPerOrg?: boolean; /** * Resource name of the parent reservation. E.g., projects/myproject/locations/US */ diff --git a/src/apis/bigtableadmin/v2.ts b/src/apis/bigtableadmin/v2.ts index 25de7a4eecd..c4be861e4b9 100644 --- a/src/apis/bigtableadmin/v2.ts +++ b/src/apis/bigtableadmin/v2.ts @@ -177,7 +177,7 @@ export namespace bigtableadmin_v2 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -651,7 +651,7 @@ export namespace bigtableadmin_v2 { updateMask?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -659,15 +659,15 @@ export namespace bigtableadmin_v2 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if either of incoming or stored policy does not meet the version requirements. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a conditional binding from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, any version compliance checks on the incoming and/or stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } @@ -3445,7 +3445,7 @@ export namespace bigtableadmin_v2 { /** * bigtableadmin.projects.instances.tables.getIamPolicy - * @desc Gets the access control policy for an instance resource. Returns an empty policy if an table exists but does not have a policy set. + * @desc Gets the access control policy for a table resource. Returns an empty policy if an table exists but does not have a policy set. * @alias bigtableadmin.projects.instances.tables.getIamPolicy * @memberOf! () * diff --git a/src/apis/binaryauthorization/v1.ts b/src/apis/binaryauthorization/v1.ts index b8ce1fe6590..881816c2480 100644 --- a/src/apis/binaryauthorization/v1.ts +++ b/src/apis/binaryauthorization/v1.ts @@ -158,7 +158,7 @@ export namespace binaryauthorization_v1 { */ updateTime?: string | null; /** - * A Grafeas Attestation.Authority Note, created by the user. + * This specifies how an attestation will be read, and how it will be used during policy enforcement. */ userOwnedGrafeasNote?: Schema$UserOwnedGrafeasNote; } @@ -192,7 +192,7 @@ export namespace binaryauthorization_v1 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -226,19 +226,19 @@ export namespace binaryauthorization_v1 { title?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$IamPolicy { /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if the incoming policy version does not meet the requirements for modifying the stored policy. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a binding (conditional or unconditional) from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, version compliance checks against the stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } diff --git a/src/apis/binaryauthorization/v1beta1.ts b/src/apis/binaryauthorization/v1beta1.ts index 685e48bbc13..3ece0a249e0 100644 --- a/src/apis/binaryauthorization/v1beta1.ts +++ b/src/apis/binaryauthorization/v1beta1.ts @@ -192,7 +192,7 @@ export namespace binaryauthorization_v1beta1 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -226,19 +226,19 @@ export namespace binaryauthorization_v1beta1 { title?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$IamPolicy { /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if the incoming policy version does not meet the requirements for modifying the stored policy. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a binding (conditional or unconditional) from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, version compliance checks against the stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } diff --git a/src/apis/chat/v1.ts b/src/apis/chat/v1.ts index ea9601f4b4c..75a1eada8d3 100644 --- a/src/apis/chat/v1.ts +++ b/src/apis/chat/v1.ts @@ -1178,7 +1178,7 @@ export namespace chat_v1 { * * @param {object} params Parameters for request * @param {string} params.name Resource name, in the form "spaces/x/messages/x". Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4 - * @param {string=} params.updateMask Required. The field paths to be updated. Currently supported field paths: "text", "cards". + * @param {string=} params.updateMask Required. The field paths to be updated, comma separated if there are multiple. Currently supported field paths: * text * cards * @param {().Message} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1299,7 +1299,7 @@ export namespace chat_v1 { */ name?: string; /** - * Required. The field paths to be updated. Currently supported field paths: "text", "cards". + * Required. The field paths to be updated, comma separated if there are multiple. Currently supported field paths: * text * cards */ updateMask?: string; diff --git a/src/apis/cloudasset/v1.ts b/src/apis/cloudasset/v1.ts index 4b953511606..ec21055f2de 100644 --- a/src/apis/cloudasset/v1.ts +++ b/src/apis/cloudasset/v1.ts @@ -103,6 +103,7 @@ export namespace cloudasset_v1 { */ export class Cloudasset { context: APIRequestContext; + feeds: Resource$Feeds; operations: Resource$Operations; v1: Resource$V1; @@ -112,6 +113,7 @@ export namespace cloudasset_v1 { google, }; + this.feeds = new Resource$Feeds(this.context); this.operations = new Resource$Operations(this.context); this.v1 = new Resource$V1(this.context); } @@ -210,7 +212,7 @@ export namespace cloudasset_v1 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -218,6 +220,23 @@ export namespace cloudasset_v1 { */ role?: string | null; } + /** + * Create asset feed request. + */ + export interface Schema$CreateFeedRequest { + /** + * Required. The feed details. The field `name` must be empty and it will be generated in the format of: projects/project_number/feeds/feed_id folders/folder_number/feeds/feed_id organizations/organization_number/feeds/feed_id + */ + feed?: Schema$Feed; + /** + * Required. This is the client-assigned asset feed identifier and it needs to be unique under a specific parent project/folder/organization. + */ + feedId?: string | null; + } + /** + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + */ + export interface Schema$Empty {} /** * Export asset request. */ @@ -260,6 +279,40 @@ export namespace cloudasset_v1 { */ title?: string | null; } + /** + * An asset feed used to export asset updates to a destinations. An asset feed filter controls what updates are exported. The asset feed must be created within a project, organization, or folder. Supported destinations are: Cloud Pub/Sub topics. + */ + export interface Schema$Feed { + /** + * A list of the full names of the assets to receive updates. You must specify either or both of asset_names and asset_types. Only asset updates matching specified asset_names and asset_types are exported to the feed. For example: `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. See [Resource Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) for more info. + */ + assetNames?: string[] | null; + /** + * A list of types of the assets to receive updates. You must specify either or both of asset_names and asset_types. Only asset updates matching specified asset_names and asset_types are exported to the feed. For example: "compute.googleapis.com/Disk" See [Introduction to Cloud Asset Inventory](https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/overview) for all supported asset types. + */ + assetTypes?: string[] | null; + /** + * Asset content type. If not specified, no content but the asset name and type will be returned. + */ + contentType?: string | null; + /** + * Required. Feed output configuration defining where the asset updates are published to. + */ + feedOutputConfig?: Schema$FeedOutputConfig; + /** + * Required. The format will be projects/{project_number}/feeds/{client-assigned_feed_identifier} or folders/{folder_number}/feeds/{client-assigned_feed_identifier} or organizations/{organization_number}/feeds/{client-assigned_feed_identifier} The client-assigned feed identifier must be unique within the parent project/folder/organization. + */ + name?: string | null; + } + /** + * Output configuration for asset feed destination. + */ + export interface Schema$FeedOutputConfig { + /** + * Destination on Cloud Pubsub. + */ + pubsubDestination?: Schema$PubsubDestination; + } /** * A Cloud Storage location. */ @@ -536,6 +589,12 @@ export namespace cloudasset_v1 { */ restrictedServices?: string[] | null; } + export interface Schema$ListFeedsResponse { + /** + * A list of feeds. + */ + feeds?: Schema$Feed[]; + } /** * This resource represents a long-running operation that is the result of a network API call. */ @@ -575,7 +634,7 @@ export namespace cloudasset_v1 { gcsDestination?: Schema$GcsDestination; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -583,18 +642,27 @@ export namespace cloudasset_v1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if the incoming policy version does not meet the requirements for modifying the stored policy. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a binding (conditional or unconditional) from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, version compliance checks against the stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } + /** + * A Cloud Pubsub destination. + */ + export interface Schema$PubsubDestination { + /** + * The name of the Cloud Pub/Sub topic to publish to. For example: `projects/PROJECT_ID/topics/TOPIC_ID`. + */ + topic?: string | null; + } /** * Representation of a cloud resource. */ @@ -671,6 +739,442 @@ export namespace cloudasset_v1 { */ startTime?: string | null; } + /** + * Update asset feed request. + */ + export interface Schema$UpdateFeedRequest { + /** + * Required. The new values of feed details. It must match an existing feed and the field `name` must be in the format of: projects/project_number/feeds/feed_id or folders/folder_number/feeds/feed_id or organizations/organization_number/feeds/feed_id. + */ + feed?: Schema$Feed; + /** + * Required. Only updates the `feed` fields indicated by this mask. The field mask must not be empty, and it must not contain fields that are immutable or only set by the server. + */ + updateMask?: string | null; + } + + export class Resource$Feeds { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * cloudasset.feeds.create + * @desc Creates a feed in a parent project/folder/organization to listen to its asset updates. + * @alias cloudasset.feeds.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The name of the project/folder/organization where this feed should be created in. It can only be an organization number (such as "organizations/123"), a folder number (such as "folders/123"), a project ID (such as "projects/my-project-id")", or a project number (such as "projects/12345"). + * @param {().CreateFeedRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params?: Params$Resource$Feeds$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Feeds$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Feeds$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Feeds$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Feeds$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Feeds$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudasset.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/feeds').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * cloudasset.feeds.delete + * @desc Deletes an asset feed. + * @alias cloudasset.feeds.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the feed and it must be in the format of: projects/project_number/feeds/feed_id folders/folder_number/feeds/feed_id organizations/organization_number/feeds/feed_id + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Feeds$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Feeds$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Feeds$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Feeds$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Feeds$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Feeds$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudasset.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * cloudasset.feeds.get + * @desc Gets details about an asset feed. + * @alias cloudasset.feeds.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the Feed and it must be in the format of: projects/project_number/feeds/feed_id folders/folder_number/feeds/feed_id organizations/organization_number/feeds/feed_id + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Feeds$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Feeds$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Feeds$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Feeds$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Feeds$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Feeds$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudasset.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * cloudasset.feeds.list + * @desc Lists all asset feeds in a parent project/folder/organization. + * @alias cloudasset.feeds.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The parent project/folder/organization whose feeds are to be listed. It can only be using project/folder/organization number (such as "folders/12345")", or a project ID (such as "projects/my-project-id"). + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Feeds$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Feeds$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Feeds$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Feeds$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Feeds$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Feeds$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudasset.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/feeds').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * cloudasset.feeds.patch + * @desc Updates an asset feed configuration. + * @alias cloudasset.feeds.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The format will be projects/{project_number}/feeds/{client-assigned_feed_identifier} or folders/{folder_number}/feeds/{client-assigned_feed_identifier} or organizations/{organization_number}/feeds/{client-assigned_feed_identifier} The client-assigned feed identifier must be unique within the parent project/folder/organization. + * @param {().UpdateFeedRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Feeds$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Feeds$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Feeds$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Feeds$Patch + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Feeds$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Feeds$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudasset.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Feeds$Create extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the project/folder/organization where this feed should be created in. It can only be an organization number (such as "organizations/123"), a folder number (such as "folders/123"), a project ID (such as "projects/my-project-id")", or a project number (such as "projects/12345"). + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreateFeedRequest; + } + export interface Params$Resource$Feeds$Delete extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the feed and it must be in the format of: projects/project_number/feeds/feed_id folders/folder_number/feeds/feed_id organizations/organization_number/feeds/feed_id + */ + name?: string; + } + export interface Params$Resource$Feeds$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the Feed and it must be in the format of: projects/project_number/feeds/feed_id folders/folder_number/feeds/feed_id organizations/organization_number/feeds/feed_id + */ + name?: string; + } + export interface Params$Resource$Feeds$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The parent project/folder/organization whose feeds are to be listed. It can only be using project/folder/organization number (such as "folders/12345")", or a project ID (such as "projects/my-project-id"). + */ + parent?: string; + } + export interface Params$Resource$Feeds$Patch extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The format will be projects/{project_number}/feeds/{client-assigned_feed_identifier} or folders/{folder_number}/feeds/{client-assigned_feed_identifier} or organizations/{organization_number}/feeds/{client-assigned_feed_identifier} The client-assigned feed identifier must be unique within the parent project/folder/organization. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UpdateFeedRequest; + } export class Resource$Operations { context: APIRequestContext; diff --git a/src/apis/cloudasset/v1beta1.ts b/src/apis/cloudasset/v1beta1.ts index 6018c17d594..36bbd223320 100644 --- a/src/apis/cloudasset/v1beta1.ts +++ b/src/apis/cloudasset/v1beta1.ts @@ -184,7 +184,7 @@ export namespace cloudasset_v1beta1 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -282,7 +282,7 @@ export namespace cloudasset_v1beta1 { gcsDestination?: Schema$GcsDestination; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -290,15 +290,15 @@ export namespace cloudasset_v1beta1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if the incoming policy version does not meet the requirements for modifying the stored policy. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a binding (conditional or unconditional) from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, version compliance checks against the stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } diff --git a/src/apis/cloudbilling/v1.ts b/src/apis/cloudbilling/v1.ts index 165337f24ee..ecd62cc4911 100644 --- a/src/apis/cloudbilling/v1.ts +++ b/src/apis/cloudbilling/v1.ts @@ -173,7 +173,7 @@ export namespace cloudbilling_v1 { */ name?: string | null; /** - * True if the billing account is open, and will therefore be charged for any usage on associated projects. False if the billing account is closed, and therefore projects associated with it will be unable to use paid services. + * Output only. True if the billing account is open, and will therefore be charged for any usage on associated projects. False if the billing account is closed, and therefore projects associated with it will be unable to use paid services. */ open?: boolean | null; } @@ -186,7 +186,7 @@ export namespace cloudbilling_v1 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example,`alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -306,7 +306,7 @@ export namespace cloudbilling_v1 { units?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -314,15 +314,15 @@ export namespace cloudbilling_v1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if either of incoming or stored policy does not meet the version requirements. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a conditional binding from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, any version compliance checks on the incoming and/or stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } @@ -687,7 +687,7 @@ export namespace cloudbilling_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the billing account to retrieve. For example, `billingAccounts/012345-567890-ABCDEF`. + * @param {string} params.name Required. The resource name of the billing account to retrieve. For example, `billingAccounts/012345-567890-ABCDEF`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1068,7 +1068,7 @@ export namespace cloudbilling_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the billing account resource to be updated. + * @param {string} params.name Required. The name of the billing account resource to be updated. * @param {string=} params.updateMask The update mask applied to the resource. Only "display_name" is currently supported. * @param {().BillingAccount} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1412,7 +1412,7 @@ export namespace cloudbilling_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the billing account to retrieve. For example, `billingAccounts/012345-567890-ABCDEF`. + * Required. The resource name of the billing account to retrieve. For example, `billingAccounts/012345-567890-ABCDEF`. */ name?: string; } @@ -1460,7 +1460,7 @@ export namespace cloudbilling_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the billing account resource to be updated. + * Required. The name of the billing account resource to be updated. */ name?: string; /** @@ -1581,7 +1581,7 @@ export namespace cloudbilling_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the billing account associated with the projects that you want to list. For example, `billingAccounts/012345-567890-ABCDEF`. + * @param {string} params.name Required. The resource name of the billing account associated with the projects that you want to list. For example, `billingAccounts/012345-567890-ABCDEF`. * @param {integer=} params.pageSize Requested page size. The maximum page size is 100; this is also the default. * @param {string=} params.pageToken A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous `ListProjectBillingInfo` call. If unspecified, the first page of results is returned. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1668,7 +1668,7 @@ export namespace cloudbilling_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the billing account associated with the projects that you want to list. For example, `billingAccounts/012345-567890-ABCDEF`. + * Required. The resource name of the billing account associated with the projects that you want to list. For example, `billingAccounts/012345-567890-ABCDEF`. */ name?: string; /** @@ -1741,7 +1741,7 @@ export namespace cloudbilling_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the project for which billing information is retrieved. For example, `projects/tokyo-rain-123`. + * @param {string} params.name Required. The resource name of the project for which billing information is retrieved. For example, `projects/tokyo-rain-123`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1869,7 +1869,7 @@ export namespace cloudbilling_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the project associated with the billing information that you want to update. For example, `projects/tokyo-rain-123`. + * @param {string} params.name Required. The resource name of the project associated with the billing information that you want to update. For example, `projects/tokyo-rain-123`. * @param {().ProjectBillingInfo} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1948,7 +1948,7 @@ export namespace cloudbilling_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the project for which billing information is retrieved. For example, `projects/tokyo-rain-123`. + * Required. The resource name of the project for which billing information is retrieved. For example, `projects/tokyo-rain-123`. */ name?: string; } @@ -1960,7 +1960,7 @@ export namespace cloudbilling_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the project associated with the billing information that you want to update. For example, `projects/tokyo-rain-123`. + * Required. The resource name of the project associated with the billing information that you want to update. For example, `projects/tokyo-rain-123`. */ name?: string; @@ -2201,7 +2201,7 @@ export namespace cloudbilling_v1 { * @param {string=} params.endTime Optional exclusive end time of the time range for which the pricing versions will be returned. Timestamps in the future are not allowed. The time range has to be within a single calendar month in America/Los_Angeles timezone. Time range as a whole is optional. If not specified, the latest pricing will be returned (up to 12 hours old at most). * @param {integer=} params.pageSize Requested page size. Defaults to 5000. * @param {string=} params.pageToken A token identifying a page of results to return. This should be a `next_page_token` value returned from a previous `ListSkus` call. If unspecified, the first page of results is returned. - * @param {string} params.parent The name of the service. Example: "services/DA34-426B-A397" + * @param {string} params.parent Required. The name of the service. Example: "services/DA34-426B-A397" * @param {string=} params.startTime Optional inclusive start time of the time range for which the pricing versions will be returned. Timestamps in the future are not allowed. The time range has to be within a single calendar month in America/Los_Angeles timezone. Time range as a whole is optional. If not specified, the latest pricing will be returned (up to 12 hours old at most). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2291,7 +2291,7 @@ export namespace cloudbilling_v1 { */ pageToken?: string; /** - * The name of the service. Example: "services/DA34-426B-A397" + * Required. The name of the service. Example: "services/DA34-426B-A397" */ parent?: string; /** diff --git a/src/apis/cloudbuild/v1.ts b/src/apis/cloudbuild/v1.ts index 0a2ff721d88..afd3fc5363a 100644 --- a/src/apis/cloudbuild/v1.ts +++ b/src/apis/cloudbuild/v1.ts @@ -307,7 +307,7 @@ export namespace cloudbuild_v1 { */ volumes?: Schema$Volume[]; /** - * Option to specify a `WorkerPool` for the build. User specifies the pool with the format "[WORKERPOOL_PROJECT_ID]/[WORKERPOOL_NAME]". This is an experimental field. + * Option to specify a `WorkerPool` for the build. Format: projects/{project}/workerPools/{workerPool} This field is experimental. */ workerPool?: string | null; } @@ -409,7 +409,7 @@ export namespace cloudbuild_v1 { */ includedFiles?: string[] | null; /** - * User assigned name of the trigger. Must be unique within the project. + * User-assigned name of the trigger. Must be unique within the project. Trigger names must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character. */ name?: string | null; /** @@ -574,7 +574,7 @@ export namespace cloudbuild_v1 { */ branch?: string | null; /** - * Whether to block builds on a "/gcbrun" comment from a repository owner or collaborator. + * Whether to block builds on a "/gcbrun" comment from a repository admin or collaborator. */ commentControl?: string | null; } diff --git a/src/apis/cloudbuild/v1alpha1.ts b/src/apis/cloudbuild/v1alpha1.ts index e66e0a94ac6..bde55aec221 100644 --- a/src/apis/cloudbuild/v1alpha1.ts +++ b/src/apis/cloudbuild/v1alpha1.ts @@ -305,7 +305,7 @@ export namespace cloudbuild_v1alpha1 { */ volumes?: Schema$Volume[]; /** - * Option to specify a `WorkerPool` for the build. User specifies the pool with the format "[WORKERPOOL_PROJECT_ID]/[WORKERPOOL_NAME]". This is an experimental field. + * Option to specify a `WorkerPool` for the build. Format: projects/{project}/workerPools/{workerPool} This field is experimental. */ workerPool?: string | null; } @@ -964,7 +964,6 @@ export namespace cloudbuild_v1alpha1 { * * @param {object} params Parameters for request * @param {string} params.name The field will contain name of the resource requested, for example: "projects/project-1/workerPools/workerpool-name" - * @param {string=} params.updateMask A mask specifying which fields in `WorkerPool` should be updated. * @param {().WorkerPool} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1094,10 +1093,6 @@ export namespace cloudbuild_v1alpha1 { * The field will contain name of the resource requested, for example: "projects/project-1/workerPools/workerpool-name" */ name?: string; - /** - * A mask specifying which fields in `WorkerPool` should be updated. - */ - updateMask?: string; /** * Request body metadata diff --git a/src/apis/clouddebugger/v2.ts b/src/apis/clouddebugger/v2.ts index daab3c52c10..f3285b0df95 100644 --- a/src/apis/clouddebugger/v2.ts +++ b/src/apis/clouddebugger/v2.ts @@ -460,7 +460,7 @@ export namespace clouddebugger_v2 { */ export interface Schema$SetBreakpointResponse { /** - * Breakpoint resource. The field `id` is guaranteed to be set (in addition to the echoed fileds). + * Breakpoint resource. The field `id` is guaranteed to be set (in addition to the echoed fields). */ breakpoint?: Schema$Breakpoint; } diff --git a/src/apis/clouderrorreporting/v1beta1.ts b/src/apis/clouderrorreporting/v1beta1.ts index 75dd4d4f0a8..a07f9d0a052 100644 --- a/src/apis/clouderrorreporting/v1beta1.ts +++ b/src/apis/clouderrorreporting/v1beta1.ts @@ -400,7 +400,7 @@ export namespace clouderrorreporting_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.projectName Required. The resource name of the Google Cloud Platform project. Written as `projects/` plus the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`. + * @param {string} params.projectName Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID}`, where `{projectID}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -481,7 +481,7 @@ export namespace clouderrorreporting_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the Google Cloud Platform project. Written as `projects/` plus the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`. + * Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID}`, where `{projectID}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`. */ projectName?: string; } @@ -502,7 +502,7 @@ export namespace clouderrorreporting_v1beta1 { * @param {string=} params.groupId Required. The group for which events shall be returned. * @param {integer=} params.pageSize Optional. The maximum number of results to return per response. * @param {string=} params.pageToken Optional. A `next_page_token` provided by a previous response. - * @param {string} params.projectName Required. The resource name of the Google Cloud Platform project. Written as `projects/` plus the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`. + * @param {string} params.projectName Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID}`, where `{projectID}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`. * @param {string=} params.serviceFilter.resourceType Optional. The exact value to match against [`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type). * @param {string=} params.serviceFilter.service Optional. The exact value to match against [`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service). * @param {string=} params.serviceFilter.version Optional. The exact value to match against [`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version). @@ -576,12 +576,12 @@ export namespace clouderrorreporting_v1beta1 { /** * clouderrorreporting.projects.events.report - * @desc Report an individual error event. This endpoint accepts **either** an OAuth token, **or** an [API key](https://support.google.com/cloud/answer/6158862) for authentication. To use an API key, append it to the URL as the value of a `key` parameter. For example: `POST https://clouderrorreporting.googleapis.com/v1beta1/projects/example-project/events:report?key=123ABC456` + * @desc Report an individual error event. This endpoint accepts **either** an OAuth token, **or** an [API key](https://support.google.com/cloud/answer/6158862) for authentication. To use an API key, append it to the URL as the value of a `key` parameter. For example: `POST https://clouderrorreporting.googleapis.com/v1beta1/{projectName}/events:report?key=123ABC456` * @alias clouderrorreporting.projects.events.report * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.projectName Required. The resource name of the Google Cloud Platform project. Written as `projects/` plus the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`. + * @param {string} params.projectName Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectId}`, where `{projectId}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: // `projects/my-project-123`. * @param {().ReportedErrorEvent} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -675,7 +675,7 @@ export namespace clouderrorreporting_v1beta1 { */ pageToken?: string; /** - * Required. The resource name of the Google Cloud Platform project. Written as `projects/` plus the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`. + * Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID}`, where `{projectID}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`. */ projectName?: string; /** @@ -703,7 +703,7 @@ export namespace clouderrorreporting_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the Google Cloud Platform project. Written as `projects/` plus the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`. + * Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectId}`, where `{projectId}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: // `projects/my-project-123`. */ projectName?: string; @@ -917,7 +917,7 @@ export namespace clouderrorreporting_v1beta1 { * @param {string=} params.order Optional. The sort order in which the results are returned. Default is `COUNT_DESC`. * @param {integer=} params.pageSize Optional. The maximum number of results to return per response. Default is 20. * @param {string=} params.pageToken Optional. A `next_page_token` provided by a previous response. To view additional results, pass this token along with the identical query parameters as the first request. - * @param {string} params.projectName Required. The resource name of the Google Cloud Platform project. Written as projects/ plus the Google Cloud Platform project ID. Example: projects/my-project-123. + * @param {string} params.projectName Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID}`, where `{projectID}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`. * @param {string=} params.serviceFilter.resourceType Optional. The exact value to match against [`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type). * @param {string=} params.serviceFilter.service Optional. The exact value to match against [`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service). * @param {string=} params.serviceFilter.version Optional. The exact value to match against [`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version). @@ -1025,7 +1025,7 @@ export namespace clouderrorreporting_v1beta1 { */ pageToken?: string; /** - * Required. The resource name of the Google Cloud Platform project. Written as projects/ plus the Google Cloud Platform project ID. Example: projects/my-project-123. + * Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID}`, where `{projectID}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`. */ projectName?: string; /** diff --git a/src/apis/cloudidentity/v1.ts b/src/apis/cloudidentity/v1.ts index 08da619f5f9..33b1438aecf 100644 --- a/src/apis/cloudidentity/v1.ts +++ b/src/apis/cloudidentity/v1.ts @@ -508,7 +508,7 @@ export namespace cloudidentity_v1 { /** * cloudidentity.groups.list - * @desc List groups within a customer or a domain. + * @desc Lists groups within a customer or a domain. * @alias cloudidentity.groups.list * @memberOf! () * @@ -1149,7 +1149,7 @@ export namespace cloudidentity_v1 { /** * cloudidentity.groups.memberships.list - * @desc List Memberships within a Group. + * @desc Lists Memberships within a Group. * @alias cloudidentity.groups.memberships.list * @memberOf! () * diff --git a/src/apis/cloudidentity/v1beta1.ts b/src/apis/cloudidentity/v1beta1.ts index 605dd3afa4c..6b9885738b7 100644 --- a/src/apis/cloudidentity/v1beta1.ts +++ b/src/apis/cloudidentity/v1beta1.ts @@ -116,112 +116,121 @@ export namespace cloudidentity_v1beta1 { } /** - * An EntityKey uniquely identifies an Entity. Namespaces are used to provide isolation for ids. A single Id can be reused across namespaces but the combination of a namespace and an id must be unique. + * A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s. */ export interface Schema$EntityKey { /** - * The id of the entity within the given namespace. The id must be unique within its namespace. + * The ID of the entity. For Google-managed entities, the `id` must be the email address of a group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`. */ id?: string | null; /** - * Namespaces provide isolation for ids, i.e an id only needs to be unique within its namespace. Namespaces are currently only created as part of IdentitySource creation from Admin Console. A namespace `"identitysources/{identity_source_id}"` is created corresponding to every Identity Source `identity_source_id`. + * The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group created through Admin Console. Must be of the form `identitysources/{identity_source_id}. */ namespace?: string | null; } /** - * Resource representing a Group + * A group within the Cloud Identity Groups API. A `Group` is a collection of entities, where each entity is either a user or another group. */ export interface Schema$Group { /** - * Optional. Additional entity key aliases for a Group + * Optional. Additional entity key aliases for a Group. */ additionalGroupKeys?: Schema$EntityKey[]; /** - * Output only. The time when the Group was created. Output only + * Output only. The time when the `Group` was created. */ createTime?: string | null; /** - * An extended description to help users determine the purpose of a Group. For example, you can include information about who should join the Group, the types of messages to send to the Group, links to FAQs about the Group, or related Groups. Maximum length is 4,096 characters. + * An extended description to help users determine the purpose of a `Group`. Must not be longer than 4,096 characters. */ description?: string | null; /** - * The Group's display name. + * The display name of the `Group`. */ displayName?: string | null; /** - * Required. Immutable. EntityKey of the Group. Must be set when creating a Group, read-only afterwards. + * Required. Immutable. The `EntityKey` of the `Group`. */ groupKey?: Schema$EntityKey; /** - * Required. Labels for Group resource. Required. For creating Groups under a namespace, set label key to 'labels/system/groups/external' and label value as empty. + * Required. The labels that apply to the `Group`. Must not contain more than one entry. Must contain the entry `'system/groups/external': ''` if the `Group` is an external-identity-mapped group or `'cloudidentity.googleapis.com/groups.discussion_forum': ''` if the `Group` is a Google Group. */ labels?: {[key: string]: string} | null; /** - * Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where group_id is the unique id assigned to the Group. Must be left blank while creating a Group + * Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group_id}`. */ name?: string | null; /** - * Required. Immutable. The entity under which this Group resides in Cloud Identity resource hierarchy. Must be set when creating a Group, read-only afterwards. Currently allowed types: 'identitysources'. + * Required. Immutable. The resource name of the entity under which this `Group` resides in the Cloud Identity resource hierarchy. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. */ parent?: string | null; /** - * Output only. The time when the Group was last updated. Output only + * Output only. The time when the `Group` was last updated. */ updateTime?: string | null; } + /** + * The response message for MembershipsService.ListMemberships. + */ export interface Schema$ListMembershipsResponse { /** - * List of Memberships + * The `Membership`s under the specified `parent`. */ memberships?: Schema$Membership[]; /** - * Token to retrieve the next page of results, or empty if there are no more results available for listing. + * A continuation token to retrieve the next page of results, or empty if there are no more results available. */ nextPageToken?: string | null; } + /** + * The response message for GroupsService.LookupGroupName. + */ export interface Schema$LookupGroupNameResponse { /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where `group_id` is the unique id assigned to the Group. + * The [resource name](https://cloud.google.com/apis/design/resource_names) of the looked-up `Group`. */ name?: string | null; } + /** + * The response message for MembershipsService.LookupMembershipName. + */ export interface Schema$LookupMembershipNameResponse { /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership being looked up. Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is the unique id assigned to the Group to which Membership belongs to, and `member_id` is the unique id assigned to the member. + * The [resource name](https://cloud.google.com/apis/design/resource_names) of the looked-up `Membership`. Must be of the form `groups/{group_id}/memberships/{membership_id}`. */ name?: string | null; } /** - * Resource representing a Membership within a Group + * A membership within the Cloud Identity Groups API. A `Membership` defines a relationship between a `Group` and an entity belonging to that `Group`, referred to as a "member". */ export interface Schema$Membership { /** - * Output only. Creation timestamp of the Membership. + * Output only. The time when the `Membership` was created. */ createTime?: string | null; /** - * Required. Immutable. EntityKey of the entity to be added as the member. Must be set while creating a Membership, read-only afterwards. Currently allowed entity types: `Users`, `Groups`. This field will be deprecated soon. + * Immutable. The `EntityKey` of the member. Either `member_key` or `preferred_member_key` must be set when calling MembershipsService.CreateMembership but not both; both shall be set when returned. */ memberKey?: Schema$EntityKey; /** - * Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership in the format: `groups/{group_id}/memberships/{member_id}`, where group_id is the unique id assigned to the Group to which Membership belongs to, and member_id is the unique id assigned to the member Must be left blank while creating a Membership. + * Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership`. Shall be of the form `groups/{group_id}/memberships/{membership_id}`. */ name?: string | null; /** - * Roles for a member within the Group. Currently supported MembershipRoles: `"MEMBER", "OWNER", "MANAGER"`. + * The `MembershipRole`s that apply to the `Membership`. If unspecified, defaults to a single `MembershipRole` with `name` `MEMBER`. Must not contain duplicate `MembershipRole`s with the same `name`. */ roles?: Schema$MembershipRole[]; /** - * Output only. Last updated timestamp of the Membership. + * Output only. The time when the `Membership` was last updated. */ updateTime?: string | null; } /** - * Resource representing a role within a Membership. + * A membership role within the Cloud Identity Groups API. A `MembershipRole` defines the privileges granted to a `Membership`. */ export interface Schema$MembershipRole { /** - * MembershipRole in string format. Currently supported MembershipRoles: `"MEMBER", "OWNER", "MANAGER"`. + * The name of the `MembershipRole`. Must be one of `OWNER`, `MANAGER`, `MEMBER`. */ name?: string | null; } @@ -250,13 +259,16 @@ export namespace cloudidentity_v1beta1 { */ response?: {[key: string]: any} | null; } + /** + * The response message for GroupsService.SearchGroups. + */ export interface Schema$SearchGroupsResponse { /** - * List of Groups satisfying the search query. + * The `Group`s that match the search query. */ groups?: Schema$Group[]; /** - * Token to retrieve the next page of results, or empty if there are no more results available for specified query. + * A continuation token to retrieve the next page of results, or empty if there are no more results available. */ nextPageToken?: string | null; } @@ -288,7 +300,7 @@ export namespace cloudidentity_v1beta1 { /** * cloudidentity.groups.create - * @desc Creates a Group. + * @desc Creates a `Group`. * @alias cloudidentity.groups.create * @memberOf! () * @@ -359,12 +371,12 @@ export namespace cloudidentity_v1beta1 { /** * cloudidentity.groups.delete - * @desc Deletes a Group. + * @desc Deletes a `Group`. * @alias cloudidentity.groups.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where `group_id` is the unique id assigned to the Group. + * @param {string} params.name The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group` to retrieve. Must be of the form `groups/{group_id}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -430,12 +442,12 @@ export namespace cloudidentity_v1beta1 { /** * cloudidentity.groups.get - * @desc Retrieves a Group. + * @desc Retrieves a `Group`. * @alias cloudidentity.groups.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where `group_id` is the unique id assigned to the Group. + * @param {string} params.name The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group` to retrieve. Must be of the form `groups/{group_id}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -499,13 +511,13 @@ export namespace cloudidentity_v1beta1 { /** * cloudidentity.groups.lookup - * @desc Looks up [resource name](https://cloud.google.com/apis/design/resource_names) of a Group by its EntityKey. + * @desc Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Group` by its `EntityKey`. * @alias cloudidentity.groups.lookup * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.groupKey.id The id of the entity within the given namespace. The id must be unique within its namespace. - * @param {string=} params.groupKey.namespace Namespaces provide isolation for ids, i.e an id only needs to be unique within its namespace. Namespaces are currently only created as part of IdentitySource creation from Admin Console. A namespace `"identitysources/{identity_source_id}"` is created corresponding to every Identity Source `identity_source_id`. + * @param {string=} params.groupKey.id The ID of the entity. For Google-managed entities, the `id` must be the email address of a group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`. + * @param {string=} params.groupKey.namespace The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group created through Admin Console. Must be of the form `identitysources/{identity_source_id}. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -578,13 +590,13 @@ export namespace cloudidentity_v1beta1 { /** * cloudidentity.groups.patch - * @desc Updates a Group. + * @desc Updates a `Group`. * @alias cloudidentity.groups.patch * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where group_id is the unique id assigned to the Group. Must be left blank while creating a Group - * @param {string=} params.updateMask Editable fields: `display_name`, `description` + * @param {string} params.name Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group_id}`. + * @param {string=} params.updateMask The fully-qualified names of fields to update. May only contain the following fields: `display_name`, `description`. * @param {().Group} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -651,15 +663,15 @@ export namespace cloudidentity_v1beta1 { /** * cloudidentity.groups.search - * @desc Searches for Groups. + * @desc Searches for `Group`s matching a specified query. * @alias cloudidentity.groups.search * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.pageSize The default page size is 200 (max 1000) for the BASIC view, and 50 (max 500) for the FULL view. - * @param {string=} params.pageToken The next_page_token value returned from a previous search request, if any. - * @param {string=} params.query Query string for performing search on groups. Users can search on namespace and label attributes of groups. EXACT match ('=') is supported on namespace, and CONTAINS match (':') is supported on labels. This is a `required` field. Multiple queries can be combined using `AND` operator. The operator is case sensitive. An example query would be: "namespace= AND labels:". - * @param {string=} params.view Group resource view to be returned. Defaults to [GroupView.BASIC](). + * @param {integer=} params.pageSize The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains a `next_page_token`. If unspecified, defaults to 200 for `GroupView.BASIC` and to 50 for `GroupView.FULL`. Must not be greater than 1000 for `GroupView.BASIC` or 500 for `GroupView.FULL`. + * @param {string=} params.pageToken The `next_page_token` value returned from a previous search request, if any. + * @param {string=} params.query The search query. Only queries on the parent and labels of `Group`s are supported. Must be specified in [Common Expression Language](https://opensource.google/projects/cel). May only contain equality operators on the parent (e.g. `parent == 'customers/{customer_id}'`) and inclusion operators on labels (e.g., `'cloudidentity.googleapis.com/groups.discussion_forum' in labels`). + * @param {string=} params.view The level of detail to be returned. If unspecified, defaults to `View.BASIC`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -747,7 +759,7 @@ export namespace cloudidentity_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where `group_id` is the unique id assigned to the Group. + * The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group` to retrieve. Must be of the form `groups/{group_id}`. */ name?: string; } @@ -758,7 +770,7 @@ export namespace cloudidentity_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where `group_id` is the unique id assigned to the Group. + * The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group` to retrieve. Must be of the form `groups/{group_id}`. */ name?: string; } @@ -769,11 +781,11 @@ export namespace cloudidentity_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id of the entity within the given namespace. The id must be unique within its namespace. + * The ID of the entity. For Google-managed entities, the `id` must be the email address of a group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`. */ 'groupKey.id'?: string; /** - * Namespaces provide isolation for ids, i.e an id only needs to be unique within its namespace. Namespaces are currently only created as part of IdentitySource creation from Admin Console. A namespace `"identitysources/{identity_source_id}"` is created corresponding to every Identity Source `identity_source_id`. + * The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group created through Admin Console. Must be of the form `identitysources/{identity_source_id}. */ 'groupKey.namespace'?: string; } @@ -784,11 +796,11 @@ export namespace cloudidentity_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where group_id is the unique id assigned to the Group. Must be left blank while creating a Group + * Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group_id}`. */ name?: string; /** - * Editable fields: `display_name`, `description` + * The fully-qualified names of fields to update. May only contain the following fields: `display_name`, `description`. */ updateMask?: string; @@ -804,19 +816,19 @@ export namespace cloudidentity_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The default page size is 200 (max 1000) for the BASIC view, and 50 (max 500) for the FULL view. + * The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains a `next_page_token`. If unspecified, defaults to 200 for `GroupView.BASIC` and to 50 for `GroupView.FULL`. Must not be greater than 1000 for `GroupView.BASIC` or 500 for `GroupView.FULL`. */ pageSize?: number; /** - * The next_page_token value returned from a previous search request, if any. + * The `next_page_token` value returned from a previous search request, if any. */ pageToken?: string; /** - * Query string for performing search on groups. Users can search on namespace and label attributes of groups. EXACT match ('=') is supported on namespace, and CONTAINS match (':') is supported on labels. This is a `required` field. Multiple queries can be combined using `AND` operator. The operator is case sensitive. An example query would be: "namespace= AND labels:". + * The search query. Only queries on the parent and labels of `Group`s are supported. Must be specified in [Common Expression Language](https://opensource.google/projects/cel). May only contain equality operators on the parent (e.g. `parent == 'customers/{customer_id}'`) and inclusion operators on labels (e.g., `'cloudidentity.googleapis.com/groups.discussion_forum' in labels`). */ query?: string; /** - * Group resource view to be returned. Defaults to [GroupView.BASIC](). + * The level of detail to be returned. If unspecified, defaults to `View.BASIC`. */ view?: string; } @@ -829,12 +841,12 @@ export namespace cloudidentity_v1beta1 { /** * cloudidentity.groups.memberships.create - * @desc Creates a Membership. + * @desc Creates a `Membership`. * @alias cloudidentity.groups.memberships.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group to create Membership within. Format: `groups/{group_id}`, where `group_id` is the unique id assigned to the Group. + * @param {string} params.parent The parent `Group` resource under which to create the `Membership`. Must be of the form `groups/{group_id}`. * @param {().Membership} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -905,12 +917,12 @@ export namespace cloudidentity_v1beta1 { /** * cloudidentity.groups.memberships.delete - * @desc Deletes a Membership. + * @desc Deletes a `Membership`. * @alias cloudidentity.groups.memberships.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership to be deleted. Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is the unique id assigned to the Group to which Membership belongs to, and member_id is the unique id assigned to the member. + * @param {string} params.name The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership` to delete. Must be of the form `groups/{group_id}/memberships/{membership_id}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -977,12 +989,12 @@ export namespace cloudidentity_v1beta1 { /** * cloudidentity.groups.memberships.get - * @desc Retrieves a Membership. + * @desc Retrieves a `Membership`. * @alias cloudidentity.groups.memberships.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership to be retrieved. Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is the unique id assigned to the Group to which Membership belongs to, and `member_id` is the unique id assigned to the member. + * @param {string} params.name The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership` to retrieve. Must be of the form `groups/{group_id}/memberships/{membership_id}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1049,15 +1061,15 @@ export namespace cloudidentity_v1beta1 { /** * cloudidentity.groups.memberships.list - * @desc List Memberships within a Group. + * @desc Lists the `Membership`s within a `Group`. * @alias cloudidentity.groups.memberships.list * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.pageSize The default page size is 200 (max 1000) for the BASIC view, and 50 (max 500) for the FULL view. - * @param {string=} params.pageToken The next_page_token value returned from a previous list request, if any - * @param {string} params.parent [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group to list Memberships within. Format: `groups/{group_id}`, where `group_id` is the unique id assigned to the Group. - * @param {string=} params.view Membership resource view to be returned. Defaults to MembershipView.BASIC. + * @param {integer=} params.pageSize The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains a `next_page_token`. If unspecified, defaults to 200 for `GroupView.BASIC` and to 50 for `GroupView.FULL`. Must not be greater than 1000 for `GroupView.BASIC` or 500 for `GroupView.FULL`. + * @param {string=} params.pageToken The `next_page_token` value returned from a previous search request, if any. + * @param {string} params.parent The parent `Group` resource under which to lookup the `Membership` name. Must be of the form `groups/{group_id}`. + * @param {string=} params.view The level of detail to be returned. If unspecified, defaults to `MembershipView.BASIC`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1129,14 +1141,14 @@ export namespace cloudidentity_v1beta1 { /** * cloudidentity.groups.memberships.lookup - * @desc Looks up [resource name](https://cloud.google.com/apis/design/resource_names) of a Membership within a Group by member's EntityKey. + * @desc Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Membership` by its `EntityKey`. * @alias cloudidentity.groups.memberships.lookup * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.memberKey.id The id of the entity within the given namespace. The id must be unique within its namespace. - * @param {string=} params.memberKey.namespace Namespaces provide isolation for ids, i.e an id only needs to be unique within its namespace. Namespaces are currently only created as part of IdentitySource creation from Admin Console. A namespace `"identitysources/{identity_source_id}"` is created corresponding to every Identity Source `identity_source_id`. - * @param {string} params.parent [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group to lookup Membership within. Format: `groups/{group_id}`, where `group_id` is the unique id assigned to the Group. + * @param {string=} params.memberKey.id The ID of the entity. For Google-managed entities, the `id` must be the email address of a group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`. + * @param {string=} params.memberKey.namespace The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group created through Admin Console. Must be of the form `identitysources/{identity_source_id}. + * @param {string} params.parent The parent `Group` resource under which to lookup the `Membership` name. Must be of the form `groups/{group_id}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1222,7 +1234,7 @@ export namespace cloudidentity_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group to create Membership within. Format: `groups/{group_id}`, where `group_id` is the unique id assigned to the Group. + * The parent `Group` resource under which to create the `Membership`. Must be of the form `groups/{group_id}`. */ parent?: string; @@ -1239,7 +1251,7 @@ export namespace cloudidentity_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership to be deleted. Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is the unique id assigned to the Group to which Membership belongs to, and member_id is the unique id assigned to the member. + * The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership` to delete. Must be of the form `groups/{group_id}/memberships/{membership_id}`. */ name?: string; } @@ -1251,7 +1263,7 @@ export namespace cloudidentity_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership to be retrieved. Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is the unique id assigned to the Group to which Membership belongs to, and `member_id` is the unique id assigned to the member. + * The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership` to retrieve. Must be of the form `groups/{group_id}/memberships/{membership_id}`. */ name?: string; } @@ -1263,19 +1275,19 @@ export namespace cloudidentity_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The default page size is 200 (max 1000) for the BASIC view, and 50 (max 500) for the FULL view. + * The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains a `next_page_token`. If unspecified, defaults to 200 for `GroupView.BASIC` and to 50 for `GroupView.FULL`. Must not be greater than 1000 for `GroupView.BASIC` or 500 for `GroupView.FULL`. */ pageSize?: number; /** - * The next_page_token value returned from a previous list request, if any + * The `next_page_token` value returned from a previous search request, if any. */ pageToken?: string; /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group to list Memberships within. Format: `groups/{group_id}`, where `group_id` is the unique id assigned to the Group. + * The parent `Group` resource under which to lookup the `Membership` name. Must be of the form `groups/{group_id}`. */ parent?: string; /** - * Membership resource view to be returned. Defaults to MembershipView.BASIC. + * The level of detail to be returned. If unspecified, defaults to `MembershipView.BASIC`. */ view?: string; } @@ -1287,15 +1299,15 @@ export namespace cloudidentity_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id of the entity within the given namespace. The id must be unique within its namespace. + * The ID of the entity. For Google-managed entities, the `id` must be the email address of a group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`. */ 'memberKey.id'?: string; /** - * Namespaces provide isolation for ids, i.e an id only needs to be unique within its namespace. Namespaces are currently only created as part of IdentitySource creation from Admin Console. A namespace `"identitysources/{identity_source_id}"` is created corresponding to every Identity Source `identity_source_id`. + * The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group created through Admin Console. Must be of the form `identitysources/{identity_source_id}. */ 'memberKey.namespace'?: string; /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group to lookup Membership within. Format: `groups/{group_id}`, where `group_id` is the unique id assigned to the Group. + * The parent `Group` resource under which to lookup the `Membership` name. Must be of the form `groups/{group_id}`. */ parent?: string; } diff --git a/src/apis/cloudiot/v1.ts b/src/apis/cloudiot/v1.ts index 1810c80a8f5..f99a2ae1f96 100644 --- a/src/apis/cloudiot/v1.ts +++ b/src/apis/cloudiot/v1.ts @@ -141,7 +141,7 @@ export namespace cloudiot_v1 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -459,19 +459,19 @@ export namespace cloudiot_v1 { mqttEnabledState?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if the incoming policy version does not meet the requirements for modifying the stored policy. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a binding (conditional or unconditional) from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, version compliance checks against the stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } diff --git a/src/apis/cloudkms/v1.ts b/src/apis/cloudkms/v1.ts index ba99d438ac0..9ca69664488 100644 --- a/src/apis/cloudkms/v1.ts +++ b/src/apis/cloudkms/v1.ts @@ -186,7 +186,7 @@ export namespace cloudkms_v1 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -255,6 +255,10 @@ export namespace cloudkms_v1 { * Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED. */ destroyTime?: string | null; + /** + * ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level. + */ + externalProtectionLevelOptions?: Schema$ExternalProtectionLevelOptions; /** * Output only. The time this CryptoKeyVersion's key material was generated. */ @@ -387,6 +391,15 @@ export namespace cloudkms_v1 { */ title?: string | null; } + /** + * ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level. + */ + export interface Schema$ExternalProtectionLevelOptions { + /** + * The URI for an external resource that this CryptoKeyVersion represents. + */ + externalKeyUri?: string | null; + } /** * Request message for KeyManagementService.ImportCryptoKeyVersion. */ @@ -591,7 +604,7 @@ export namespace cloudkms_v1 { hsmAvailable?: boolean | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -599,15 +612,15 @@ export namespace cloudkms_v1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if the incoming policy version does not meet the requirements for modifying the stored policy. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a binding (conditional or unconditional) from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, version compliance checks against the stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } diff --git a/src/apis/cloudprivatecatalogproducer/v1beta1.ts b/src/apis/cloudprivatecatalogproducer/v1beta1.ts index f208ecafe96..637cbf5375d 100644 --- a/src/apis/cloudprivatecatalogproducer/v1beta1.ts +++ b/src/apis/cloudprivatecatalogproducer/v1beta1.ts @@ -315,7 +315,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { */ condition?: Schema$GoogleTypeExpr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -324,7 +324,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { role?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$GoogleIamV1Policy { /** @@ -332,15 +332,15 @@ export namespace cloudprivatecatalogproducer_v1beta1 { */ auditConfigs?: Schema$GoogleIamV1AuditConfig[]; /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$GoogleIamV1Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if the incoming policy version does not meet the requirements for modifying the stored policy. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a binding (conditional or unconditional) from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, version compliance checks against the stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } diff --git a/src/apis/cloudresourcemanager/v1.ts b/src/apis/cloudresourcemanager/v1.ts index cb8d51976fc..9c79a8bf482 100644 --- a/src/apis/cloudresourcemanager/v1.ts +++ b/src/apis/cloudresourcemanager/v1.ts @@ -167,7 +167,7 @@ export namespace cloudresourcemanager_v1 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -576,7 +576,7 @@ export namespace cloudresourcemanager_v1 { version?: number | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -584,15 +584,15 @@ export namespace cloudresourcemanager_v1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if the incoming policy version does not meet the requirements for modifying the stored policy. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a binding (conditional or unconditional) from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, version compliance checks against the stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } diff --git a/src/apis/cloudresourcemanager/v1beta1.ts b/src/apis/cloudresourcemanager/v1beta1.ts index 83acee74e67..24e4f551aec 100644 --- a/src/apis/cloudresourcemanager/v1beta1.ts +++ b/src/apis/cloudresourcemanager/v1beta1.ts @@ -161,7 +161,7 @@ export namespace cloudresourcemanager_v1beta1 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -320,7 +320,7 @@ export namespace cloudresourcemanager_v1beta1 { directoryCustomerId?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -328,15 +328,15 @@ export namespace cloudresourcemanager_v1beta1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if the incoming policy version does not meet the requirements for modifying the stored policy. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a binding (conditional or unconditional) from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, version compliance checks against the stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } @@ -1382,7 +1382,7 @@ export namespace cloudresourcemanager_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.useLegacyStack A safety hatch to opt out of the new reliable project creation process. + * @param {boolean=} params.useLegacyStack A now unused experiment opt-out option. * @param {().Project} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2575,7 +2575,7 @@ export namespace cloudresourcemanager_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A safety hatch to opt out of the new reliable project creation process. + * A now unused experiment opt-out option. */ useLegacyStack?: boolean; diff --git a/src/apis/cloudresourcemanager/v2.ts b/src/apis/cloudresourcemanager/v2.ts index 46bc4a26d9d..491a88ccd4b 100644 --- a/src/apis/cloudresourcemanager/v2.ts +++ b/src/apis/cloudresourcemanager/v2.ts @@ -152,7 +152,7 @@ export namespace cloudresourcemanager_v2 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -302,7 +302,7 @@ export namespace cloudresourcemanager_v2 { response?: {[key: string]: any} | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -310,15 +310,15 @@ export namespace cloudresourcemanager_v2 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if the incoming policy version does not meet the requirements for modifying the stored policy. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a binding (conditional or unconditional) from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, version compliance checks against the stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } diff --git a/src/apis/cloudresourcemanager/v2beta1.ts b/src/apis/cloudresourcemanager/v2beta1.ts index 3e073fb1fd6..5ac79972901 100644 --- a/src/apis/cloudresourcemanager/v2beta1.ts +++ b/src/apis/cloudresourcemanager/v2beta1.ts @@ -152,7 +152,7 @@ export namespace cloudresourcemanager_v2beta1 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -302,7 +302,7 @@ export namespace cloudresourcemanager_v2beta1 { response?: {[key: string]: any} | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -310,15 +310,15 @@ export namespace cloudresourcemanager_v2beta1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if the incoming policy version does not meet the requirements for modifying the stored policy. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a binding (conditional or unconditional) from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, version compliance checks against the stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } diff --git a/src/apis/cloudsearch/v1.ts b/src/apis/cloudsearch/v1.ts index 9a267b7c3cc..97cd1cb1d9f 100644 --- a/src/apis/cloudsearch/v1.ts +++ b/src/apis/cloudsearch/v1.ts @@ -230,7 +230,7 @@ export namespace cloudsearch_v1 { */ indexingServiceAccounts?: string[] | null; /** - * This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility. + * This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility. This should not be set if anonymous search is enabled for the data source. */ itemsVisibility?: Schema$GSuitePrincipal[]; /** @@ -1343,7 +1343,7 @@ export namespace cloudsearch_v1 { export interface Schema$QueryInterpretation { interpretationType?: string | null; /** - * The interpretation of the query used in search. For example, queries with natural language intent like "email from john" will be interpreted as "from:john source:mail". This field will not be filled when the reason is NO_RESULTS_FOUND_FOR_USER_QUERY. + * The interpretation of the query used in search. For example, queries with natural language intent like "email from john" will be interpreted as "from:john source:mail". This field will not be filled when the reason is NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY. */ interpretedQuery?: string | null; /** @@ -1413,6 +1413,10 @@ export namespace cloudsearch_v1 { * Indicates the operator name that can be used to isolate the property using the less-than operator. */ lessThanOperatorName?: string | null; + /** + * Name of the object corresponding to the operator. This field is only filled for schema-specific operators, and is unset for common operators. + */ + objectType?: string | null; /** * The name of the operator. */ @@ -2121,7 +2125,7 @@ export namespace cloudsearch_v1 { */ schema?: Schema$Schema; /** - * If true, the request will be validated without side effects. + * If true, the schema will be checked for validity, but will not be registered with the data source, even if valid. */ validateOnly?: boolean | null; } diff --git a/src/apis/cloudtasks/v2.ts b/src/apis/cloudtasks/v2.ts index 73e9c2094f7..e439bc614ec 100644 --- a/src/apis/cloudtasks/v2.ts +++ b/src/apis/cloudtasks/v2.ts @@ -128,7 +128,7 @@ export namespace cloudtasks_v2 { */ body?: string | null; /** - * HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. Repeated headers are not supported but a header value can contain commas. Cloud Tasks sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Tasks will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. If the task has a body, Cloud Tasks sets the following headers: * `Content-Type`: By default, the `Content-Type` header is set to `"application/octet-stream"`. The default can be overridden by explicitly setting `Content-Type` to a particular media type when the task is created. For example, `Content-Type` can be set to `"application/json"`. * `Content-Length`: This is computed by Cloud Tasks. This value is output only. It cannot be changed. The headers below cannot be set or overridden: * `Host` * `X-Google-*` * `X-AppEngine-*` In addition, Cloud Tasks sets some headers when the task is dispatched, such as headers containing information about the task; see [request headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers). These headers are set only when the task is dispatched, so they are not visible when the task is returned in a Cloud Tasks response. Although there is no specific limit for the maximum number of headers or the size, there is a limit on the maximum size of the Task. For more information, see the CreateTask documentation. + * HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. Repeated headers are not supported but a header value can contain commas. Cloud Tasks sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Tasks will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. If the task has a body, Cloud Tasks sets the following headers: * `Content-Type`: By default, the `Content-Type` header is set to `"application/octet-stream"`. The default can be overridden by explicitly setting `Content-Type` to a particular media type when the task is created. For example, `Content-Type` can be set to `"application/json"`. * `Content-Length`: This is computed by Cloud Tasks. This value is output only. It cannot be changed. The headers below cannot be set or overridden: * `Host` * `X-Google-*` * `X-AppEngine-*` In addition, Cloud Tasks sets some headers when the task is dispatched, such as headers containing information about the task; see [request headers](https://cloud.google.com/tasks/docs/creating-appengine-handlers#reading_request_headers). These headers are set only when the task is dispatched, so they are not visible when the task is returned in a Cloud Tasks response. Although there is no specific limit for the maximum number of headers or the size, there is a limit on the maximum size of the Task. For more information, see the CreateTask documentation. */ headers?: {[key: string]: string} | null; /** @@ -191,7 +191,7 @@ export namespace cloudtasks_v2 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -256,7 +256,7 @@ export namespace cloudtasks_v2 { requestedPolicyVersion?: number | null; } /** - * HTTP request. The task will be pushed to the worker as an HTTP request. If the worker or the redirected worker acknowledges the task by returning a successful HTTP response code ([`200` - `299`]), the task will removed from the queue. If any other HTTP response code is returned or no response is received, the task will be retried according to the following: * User-specified throttling: retry configuration, rate limits, and the queue's state. * System throttling: To prevent the worker from overloading, Cloud Tasks may temporarily reduce the queue's effective rate. User-specified settings will not be changed. System throttling happens because: * Cloud Tasks backs off on all errors. Normally the backoff specified in rate limits will be used. But if the worker returns `429` (Too Many Requests), `503` (Service Unavailable), or the rate of errors is high, Cloud Tasks will use a higher backoff rate. The retry specified in the `Retry-After` HTTP response header is considered. * To prevent traffic spikes and to smooth sudden large traffic spikes, dispatches ramp up slowly when the queue is newly created or idle and if large numbers of tasks suddenly become available to dispatch (due to spikes in create task rates, the queue being unpaused, or many tasks that are scheduled at the same time). + * HTTP request. The task will be pushed to the worker as an HTTP request. If the worker or the redirected worker acknowledges the task by returning a successful HTTP response code ([`200` - `299`]), the task will be removed from the queue. If any other HTTP response code is returned or no response is received, the task will be retried according to the following: * User-specified throttling: retry configuration, rate limits, and the queue's state. * System throttling: To prevent the worker from overloading, Cloud Tasks may temporarily reduce the queue's effective rate. User-specified settings will not be changed. System throttling happens because: * Cloud Tasks backs off on all errors. Normally the backoff specified in rate limits will be used. But if the worker returns `429` (Too Many Requests), `503` (Service Unavailable), or the rate of errors is high, Cloud Tasks will use a higher backoff rate. The retry specified in the `Retry-After` HTTP response header is considered. * To prevent traffic spikes and to smooth sudden increases in traffic, dispatches ramp up slowly when the queue is newly created or idle and if large numbers of tasks suddenly become available to dispatch (due to spikes in create task rates, the queue being unpaused, or many tasks that are scheduled at the same time). */ export interface Schema$HttpRequest { /** @@ -379,19 +379,19 @@ export namespace cloudtasks_v2 { */ export interface Schema$PauseQueueRequest {} /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if the incoming policy version does not meet the requirements for modifying the stored policy. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a binding (conditional or unconditional) from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, version compliance checks against the stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } diff --git a/src/apis/cloudtasks/v2beta2.ts b/src/apis/cloudtasks/v2beta2.ts index 8afebd3eaff..b237a1644fe 100644 --- a/src/apis/cloudtasks/v2beta2.ts +++ b/src/apis/cloudtasks/v2beta2.ts @@ -209,7 +209,7 @@ export namespace cloudtasks_v2beta2 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -385,19 +385,19 @@ export namespace cloudtasks_v2beta2 { */ export interface Schema$PauseQueueRequest {} /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if the incoming policy version does not meet the requirements for modifying the stored policy. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a binding (conditional or unconditional) from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, version compliance checks against the stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } diff --git a/src/apis/cloudtasks/v2beta3.ts b/src/apis/cloudtasks/v2beta3.ts index 3373f9511b8..c4ebbd2f0ea 100644 --- a/src/apis/cloudtasks/v2beta3.ts +++ b/src/apis/cloudtasks/v2beta3.ts @@ -137,7 +137,7 @@ export namespace cloudtasks_v2beta3 { */ body?: string | null; /** - * HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. Repeated headers are not supported but a header value can contain commas. Cloud Tasks sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Tasks will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. If the task has a body, Cloud Tasks sets the following headers: * `Content-Type`: By default, the `Content-Type` header is set to `"application/octet-stream"`. The default can be overridden by explicitly setting `Content-Type` to a particular media type when the task is created. For example, `Content-Type` can be set to `"application/json"`. * `Content-Length`: This is computed by Cloud Tasks. This value is output only. It cannot be changed. The headers below cannot be set or overridden: * `Host` * `X-Google-*` * `X-AppEngine-*` In addition, Cloud Tasks sets some headers when the task is dispatched, such as headers containing information about the task; see [request headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers). These headers are set only when the task is dispatched, so they are not visible when the task is returned in a Cloud Tasks response. Although there is no specific limit for the maximum number of headers or the size, there is a limit on the maximum size of the Task. For more information, see the CreateTask documentation. + * HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. Repeated headers are not supported but a header value can contain commas. Cloud Tasks sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Tasks will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. If the task has a body, Cloud Tasks sets the following headers: * `Content-Type`: By default, the `Content-Type` header is set to `"application/octet-stream"`. The default can be overridden by explicitly setting `Content-Type` to a particular media type when the task is created. For example, `Content-Type` can be set to `"application/json"`. * `Content-Length`: This is computed by Cloud Tasks. This value is output only. It cannot be changed. The headers below cannot be set or overridden: * `Host` * `X-Google-*` * `X-AppEngine-*` In addition, Cloud Tasks sets some headers when the task is dispatched, such as headers containing information about the task; see [request headers](https://cloud.google.com/tasks/docs/creating-appengine-handlers#reading_request_headers). These headers are set only when the task is dispatched, so they are not visible when the task is returned in a Cloud Tasks response. Although there is no specific limit for the maximum number of headers or the size, there is a limit on the maximum size of the Task. For more information, see the CreateTask documentation. */ headers?: {[key: string]: string} | null; /** @@ -200,7 +200,7 @@ export namespace cloudtasks_v2beta3 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -265,7 +265,7 @@ export namespace cloudtasks_v2beta3 { requestedPolicyVersion?: number | null; } /** - * HTTP request. The task will be pushed to the worker as an HTTP request. If the worker or the redirected worker acknowledges the task by returning a successful HTTP response code ([`200` - `299`]), the task will removed from the queue. If any other HTTP response code is returned or no response is received, the task will be retried according to the following: * User-specified throttling: retry configuration, rate limits, and the queue's state. * System throttling: To prevent the worker from overloading, Cloud Tasks may temporarily reduce the queue's effective rate. User-specified settings will not be changed. System throttling happens because: * Cloud Tasks backs off on all errors. Normally the backoff specified in rate limits will be used. But if the worker returns `429` (Too Many Requests), `503` (Service Unavailable), or the rate of errors is high, Cloud Tasks will use a higher backoff rate. The retry specified in the `Retry-After` HTTP response header is considered. * To prevent traffic spikes and to smooth sudden large traffic spikes, dispatches ramp up slowly when the queue is newly created or idle and if large numbers of tasks suddenly become available to dispatch (due to spikes in create task rates, the queue being unpaused, or many tasks that are scheduled at the same time). + * HTTP request. The task will be pushed to the worker as an HTTP request. If the worker or the redirected worker acknowledges the task by returning a successful HTTP response code ([`200` - `299`]), the task will be removed from the queue. If any other HTTP response code is returned or no response is received, the task will be retried according to the following: * User-specified throttling: retry configuration, rate limits, and the queue's state. * System throttling: To prevent the worker from overloading, Cloud Tasks may temporarily reduce the queue's effective rate. User-specified settings will not be changed. System throttling happens because: * Cloud Tasks backs off on all errors. Normally the backoff specified in rate limits will be used. But if the worker returns `429` (Too Many Requests), `503` (Service Unavailable), or the rate of errors is high, Cloud Tasks will use a higher backoff rate. The retry specified in the `Retry-After` HTTP response header is considered. * To prevent traffic spikes and to smooth sudden increases in traffic, dispatches ramp up slowly when the queue is newly created or idle and if large numbers of tasks suddenly become available to dispatch (due to spikes in create task rates, the queue being unpaused, or many tasks that are scheduled at the same time). */ export interface Schema$HttpRequest { /** @@ -388,19 +388,19 @@ export namespace cloudtasks_v2beta3 { */ export interface Schema$PauseQueueRequest {} /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if the incoming policy version does not meet the requirements for modifying the stored policy. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a binding (conditional or unconditional) from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, version compliance checks against the stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } diff --git a/src/apis/cloudtrace/v2.ts b/src/apis/cloudtrace/v2.ts index c3493682e8c..4e67b485671 100644 --- a/src/apis/cloudtrace/v2.ts +++ b/src/apis/cloudtrace/v2.ts @@ -252,11 +252,11 @@ export namespace cloudtrace_v2 { */ childSpanCount?: number | null; /** - * A description of the span's operation (up to 128 bytes). Stackdriver Trace displays the description in the Google Cloud Platform Console. For example, the display name can be a qualified method name or a file name and a line number where the operation is called. A best practice is to use the same display name within an application and at the same call point. This makes it easier to correlate spans in different traces. + * Required. A description of the span's operation (up to 128 bytes). Stackdriver Trace displays the description in the Google Cloud Platform Console. For example, the display name can be a qualified method name or a file name and a line number where the operation is called. A best practice is to use the same display name within an application and at the same call point. This makes it easier to correlate spans in different traces. */ displayName?: Schema$TruncatableString; /** - * The end time of the span. On the client side, this is the time kept by the local machine where the span execution ends. On the server side, this is the time when the server application handler stops running. + * Required. The end time of the span. On the client side, this is the time kept by the local machine where the span execution ends. On the server side, this is the time when the server application handler stops running. */ endTime?: string | null; /** @@ -276,7 +276,7 @@ export namespace cloudtrace_v2 { */ sameProcessAsParentSpan?: boolean | null; /** - * The [SPAN_ID] portion of the span's resource name. + * Required. The [SPAN_ID] portion of the span's resource name. */ spanId?: string | null; /** @@ -288,7 +288,7 @@ export namespace cloudtrace_v2 { */ stackTrace?: Schema$StackTrace; /** - * The start time of the span. On the client side, this is the time kept by the local machine where the span execution starts. On the server side, this is the time when the server's application handler starts running. + * Required. The start time of the span. On the client side, this is the time kept by the local machine where the span execution starts. On the server side, this is the time when the server's application handler starts running. */ startTime?: string | null; /** diff --git a/src/apis/compute/alpha.ts b/src/apis/compute/alpha.ts index e6d1b421166..c86b8e55c2c 100644 --- a/src/apis/compute/alpha.ts +++ b/src/apis/compute/alpha.ts @@ -137,6 +137,7 @@ export namespace compute_alpha { regionHealthCheckServices: Resource$Regionhealthcheckservices; regionInstanceGroupManagers: Resource$Regioninstancegroupmanagers; regionInstanceGroups: Resource$Regioninstancegroups; + regionNetworkEndpointGroups: Resource$Regionnetworkendpointgroups; regionNotificationEndpoints: Resource$Regionnotificationendpoints; regionOperations: Resource$Regionoperations; regions: Resource$Regions; @@ -252,6 +253,9 @@ export namespace compute_alpha { this.regionInstanceGroups = new Resource$Regioninstancegroups( this.context ); + this.regionNetworkEndpointGroups = new Resource$Regionnetworkendpointgroups( + this.context + ); this.regionNotificationEndpoints = new Resource$Regionnotificationendpoints( this.context ); @@ -772,7 +776,7 @@ export namespace compute_alpha { */ diskName?: string | null; /** - * Specifies the size of the disk in base-2 GB. If not specified, the disk will be the same size as the image (usually 10GB). If specified, the size must be equal to or larger than 10GB. + * Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB. */ diskSizeGb?: string | null; /** @@ -928,7 +932,7 @@ export namespace compute_alpha { */ selfLinkWithId?: string | null; /** - * [Output Only] The status of the autoscaler configuration. Current set of possible values: PENDING: Autoscaler backend hasn't read new/updated configuration DELETING: Configuration is being deleted ACTIVE: Configuration is acknowledged to be effective. Some warnings might or might not be present in the status_details field. ERROR: Configuration has errors. Actionable for users. Details are present in the status_details field. New values might be added in the future. + * [Output Only] The status of the autoscaler configuration. Current set of possible values: - PENDING: Autoscaler backend hasn't read new/updated configuration. - DELETING: Configuration is being deleted. - ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field. - ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future. */ status?: string | null; /** @@ -1027,7 +1031,7 @@ export namespace compute_alpha { */ message?: string | null; /** - * The type of error, warning or notice returned. Current set of possible values: ALL_INSTANCES_UNHEALTHY (WARNING): All instances in the instance group are unhealthy (not in RUNNING state). BACKEND_SERVICE_DOES_NOT_EXIST (ERROR): There is no backend service attached to the instance group. CAPPED_AT_MAX_NUM_REPLICAS (WARNING): Autoscaler recommends size bigger than maxNumReplicas. CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE (WARNING): The custom metric samples are not exported often enough to be a credible base for autoscaling. CUSTOM_METRIC_INVALID (ERROR): The custom metric that was specified does not exist or does not have the necessary labels. MIN_EQUALS_MAX (WARNING): The minNumReplicas is equal to maxNumReplicas. This means the autoscaler cannot add or remove instances from the instance group. MISSING_CUSTOM_METRIC_DATA_POINTS (WARNING): The autoscaler did not receive any data from the custom metric configured for autoscaling. MISSING_LOAD_BALANCING_DATA_POINTS (WARNING): The autoscaler is configured to scale based on a load balancing signal but the instance group has not received any requests from the load balancer. MODE_OFF (WARNING): Autoscaling is turned off. The number of instances in the group won't change automatically. The autoscaling configuration is preserved. MODE_ONLY_UP (WARNING): Autoscaling is in the "Autoscale only up" mode. Instances in the group will be only added. MORE_THAN_ONE_BACKEND_SERVICE (ERROR): The instance group cannot be autoscaled because it has more than one backend service attached to it. NOT_ENOUGH_QUOTA_AVAILABLE (ERROR): Exceeded quota for necessary resources, such as CPU, number of instances and so on. REGION_RESOURCE_STOCKOUT (ERROR): Showed only for regional autoscalers: there is a resource stockout in the chosen region. SCALING_TARGET_DOES_NOT_EXIST (ERROR): The target to be scaled does not exist. UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION (ERROR): Autoscaling does not work with an HTTP/S load balancer that has been configured for maxRate. ZONE_RESOURCE_STOCKOUT (ERROR): For zonal autoscalers: there is a resource stockout in the chosen zone. For regional autoscalers: in at least one of the zones you're using there is a resource stockout. New values might be added in the future. Some of the values might not be available in all API versions. + * The type of error, warning, or notice returned. Current set of possible values: - ALL_INSTANCES_UNHEALTHY (WARNING): All instances in the instance group are unhealthy (not in RUNNING state). - BACKEND_SERVICE_DOES_NOT_EXIST (ERROR): There is no backend service attached to the instance group. - CAPPED_AT_MAX_NUM_REPLICAS (WARNING): Autoscaler recommends a size greater than maxNumReplicas. - CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE (WARNING): The custom metric samples are not exported often enough to be a credible base for autoscaling. - CUSTOM_METRIC_INVALID (ERROR): The custom metric that was specified does not exist or does not have the necessary labels. - MIN_EQUALS_MAX (WARNING): The minNumReplicas is equal to maxNumReplicas. This means the autoscaler cannot add or remove instances from the instance group. - MISSING_CUSTOM_METRIC_DATA_POINTS (WARNING): The autoscaler did not receive any data from the custom metric configured for autoscaling. - MISSING_LOAD_BALANCING_DATA_POINTS (WARNING): The autoscaler is configured to scale based on a load balancing signal but the instance group has not received any requests from the load balancer. - MODE_OFF (WARNING): Autoscaling is turned off. The number of instances in the group won't change automatically. The autoscaling configuration is preserved. - MODE_ONLY_UP (WARNING): Autoscaling is in the "Autoscale only up" mode. The autoscaler can add instances but not remove any. - MORE_THAN_ONE_BACKEND_SERVICE (ERROR): The instance group cannot be autoscaled because it has more than one backend service attached to it. - NOT_ENOUGH_QUOTA_AVAILABLE (ERROR): There is insufficient quota for the necessary resources, such as CPU or number of instances. - REGION_RESOURCE_STOCKOUT (ERROR): Shown only for regional autoscalers: there is a resource stockout in the chosen region. - SCALING_TARGET_DOES_NOT_EXIST (ERROR): The target to be scaled does not exist. - UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION (ERROR): Autoscaling does not work with an HTTP/S load balancer that has been configured for maxRate. - ZONE_RESOURCE_STOCKOUT (ERROR): For zonal autoscalers: there is a resource stockout in the chosen zone. For regional autoscalers: in at least one of the zones you're using there is a resource stockout. New values might be added in the future. Some of the values might not be available in all API versions. */ type?: string | null; } @@ -1366,7 +1370,7 @@ export namespace compute_alpha { */ loadBalancingScheme?: string | null; /** - * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. + * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. If sessionAffinity is not NONE, and this field is not set to >MAGLEV or RING_HASH, session affinity settings will not take effect. */ localityLbPolicy?: string | null; /** @@ -1418,7 +1422,7 @@ export namespace compute_alpha { */ selfLinkWithId?: string | null; /** - * Type of session affinity to use. The default is NONE. Session affinity is not applicable if the --protocol is UDP. When the loadBalancingScheme is EXTERNAL, possible values are NONE, CLIENT_IP, or GENERATED_COOKIE. You can use GENERATED_COOKIE if the protocol is HTTP or HTTPS. When the loadBalancingScheme is INTERNAL, possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. When the loadBalancingScheme is INTERNAL_SELF_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE. + * Type of session affinity to use. The default is NONE. Session affinity is not applicable if the --protocol is UDP. When the loadBalancingScheme is EXTERNAL, possible values are NONE, CLIENT_IP, or GENERATED_COOKIE. You can use GENERATED_COOKIE if the protocol is HTTP or HTTPS. When the loadBalancingScheme is INTERNAL, possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. When the loadBalancingScheme is INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE. */ sessionAffinity?: string | null; /** @@ -1751,7 +1755,7 @@ export namespace compute_alpha { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example,`alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -2144,7 +2148,7 @@ export namespace compute_alpha { */ kmsKeyName?: string | null; /** - * The service account being used for the encryption request for the given KMS key. If absent, default GCE compute robot account will be used + * The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. */ kmsKeyServiceAccount?: string | null; /** @@ -2323,6 +2327,10 @@ export namespace compute_alpha { * [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used. */ sourceSnapshotId?: string | null; + /** + * The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/. + */ + sourceStorageObject?: string | null; /** * [Output Only] The status of disk creation. CREATING: Disk is provisioning. RESTORING: Source data is being copied into the disk. FAILED: Disk creation failed. READY: Disk is ready for use. DELETING: Disk is deleting. */ @@ -2610,6 +2618,10 @@ export namespace compute_alpha { enableDisplay?: boolean | null; } export interface Schema$DistributionPolicy { + /** + * The shape to which the group converges either proactively or on resize events (depending on the value set in updatePolicy.instanceRedistributionType). The possible values are EVEN and ANY. For EVEN the group attempts to preserve a balanced number of instances across zones. For ANY the group creates new instances where resources are available to fulfill the request; as a result, instances may be distributed unevenly across zones in this mode. The default value is EVEN. + */ + targetShape?: string | null; /** * Zones where the regional managed instance group will create and manage instances. */ @@ -2995,7 +3007,7 @@ export namespace compute_alpha { */ IPAddress?: string | null; /** - * The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP. For Internal TCP/UDP Load Balancing, the load balancing scheme is INTERNAL, and one of TCP or UDP are valid. For Traffic Director, the load balancing scheme is INTERNAL_SELF_MANAGED, and only TCPis valid. For Internal HTTP(S) Load Balancing, the load balancing scheme is INTERNAL_MANAGED, and only TCP is valid. For HTTP(S), SSL Proxy, and TCP Proxy Load Balancing, the load balancing scheme is EXTERNAL and only TCP is valid. For Network TCP/UDP Load Balancing, the load balancing scheme is EXTERNAL, and one of TCP or UDP is valid. + * The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP or ICMP. For Internal TCP/UDP Load Balancing, the load balancing scheme is INTERNAL, and one of TCP or UDP are valid. For Traffic Director, the load balancing scheme is INTERNAL_SELF_MANAGED, and only TCPis valid. For Internal HTTP(S) Load Balancing, the load balancing scheme is INTERNAL_MANAGED, and only TCP is valid. For HTTP(S), SSL Proxy, and TCP Proxy Load Balancing, the load balancing scheme is EXTERNAL and only TCP is valid. For Network TCP/UDP Load Balancing, the load balancing scheme is EXTERNAL, and one of TCP or UDP is valid. */ IPProtocol?: string | null; /** @@ -3023,7 +3035,7 @@ export namespace compute_alpha { */ loadBalancingScheme?: string | null; /** - * Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. metadataFilters specified here can be overridden by those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. + * Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule will not be visible to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. metadataFilters specified here will be applifed before those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. */ metadataFilters?: Schema$MetadataFilter[]; /** @@ -3039,11 +3051,11 @@ export namespace compute_alpha { */ networkTier?: string | null; /** - * This field is deprecated. See the port field. + * When the load balancing scheme is EXTERNAL, INTERNAL_SELF_MANAGED and INTERNAL_MANAGED, you can specify a port_range. Use with a forwarding rule that points to a target proxy or a target pool. Do not use with a forwarding rule that points to a backend service. This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges. Some types of forwarding target have constraints on the acceptable ports: - TargetHttpProxy: 80, 8080 - TargetHttpsProxy: 443 - TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 - TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 - TargetVpnGateway: 500, 4500 */ portRange?: string | null; /** - * List of comma-separated ports. The forwarding rule forwards packets with matching destination ports. If the forwarding rule's loadBalancingScheme is EXTERNAL, and the forwarding rule references a target pool, specifying ports is optional. You can specify an unlimited number of ports, but they must be contiguous. If you omit ports, GCP forwards traffic on any port of the forwarding rule's protocol. If the forwarding rule's loadBalancingScheme is EXTERNAL, and the forwarding rule references a target HTTP proxy, target HTTPS proxy, target TCP proxy, target SSL proxy, or target VPN gateway, you must specify ports using the following constraints: - TargetHttpProxy: 80, 8080 - TargetHttpsProxy: 443 - TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 - TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 - TargetVpnGateway: 500, 4500 If the forwarding rule's loadBalancingScheme is INTERNAL, you must specify ports in one of the following ways: * A list of up to five ports, which can be non-contiguous * Keyword ALL, which causes the forwarding rule to forward traffic on any port of the forwarding rule's protocol. The ports field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. Applicable only when IPProtocol is TCP, UDP, or SCTP. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges. + * This field is used along with the backend_service field for internal load balancing. When the load balancing scheme is INTERNAL, a list of ports can be configured, for example, ['80'], ['8000','9000']. Only packets addressed to these ports are forwarded to the backends configured with the forwarding rule. If the forwarding rule's loadBalancingScheme is INTERNAL, you can specify ports in one of the following ways: * A list of up to five ports, which can be non-contiguous * Keyword ALL, which causes the forwarding rule to forward traffic on any port of the forwarding rule's protocol. */ ports?: string[] | null; /** @@ -3217,7 +3229,7 @@ export namespace compute_alpha { */ kind?: string | null; /** - * The path to be queried. This can be the default namespace ('/') or a nested namespace ('//') or a specified key ('//') + * The path to be queried. This can be the default namespace ('/') or a nested namespace ('/\/') or a specified key ('/\/\') */ queryPath?: string | null; /** @@ -3693,7 +3705,7 @@ export namespace compute_alpha { */ prefixMatch?: string | null; /** - * A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value or not. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. + * A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. */ presentMatch?: boolean | null; /** @@ -3855,7 +3867,7 @@ export namespace compute_alpha { */ export interface Schema$HttpQueryParameterMatch { /** - * The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch and regexMatch must be set. + * The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch or regexMatch must be set. */ exactMatch?: string | null; /** @@ -3863,11 +3875,11 @@ export namespace compute_alpha { */ name?: string | null; /** - * Specifies that the queryParameterMatch matches if the request contains the query parameter, irrespective of whether the parameter has a value or not. Only one of presentMatch, exactMatch and regexMatch must be set. + * Specifies that the queryParameterMatch matches if the request contains the query parameter, irrespective of whether the parameter has a value or not. Only one of presentMatch, exactMatch or regexMatch must be set. */ presentMatch?: boolean | null; /** - * The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch, exactMatch and regexMatch must be set. + * The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch, exactMatch or regexMatch must be set. */ regexMatch?: string | null; } @@ -3939,7 +3951,7 @@ export namespace compute_alpha { */ timeout?: Schema$Duration; /** - * The spec to modify the URL of the request, prior to forwarding the request to the matched service + * The spec to modify the URL of the request, prior to forwarding the request to the matched service. */ urlRewrite?: Schema$UrlRewrite; /** @@ -3965,7 +3977,7 @@ export namespace compute_alpha { */ priority?: number | null; /** - * In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. + * In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. */ routeAction?: Schema$HttpRouteAction; /** @@ -3982,7 +3994,7 @@ export namespace compute_alpha { */ export interface Schema$HttpRouteRuleMatch { /** - * For satifying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL. FullPathMatch must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified. + * For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL. fullPathMatch must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified. */ fullPathMatch?: string | null; /** @@ -3990,15 +4002,15 @@ export namespace compute_alpha { */ headerMatches?: Schema$HttpHeaderMatch[]; /** - * Specifies that prefixMatch and fullPathMatch matches are case sensitive. The default value is false. caseSensitive must not be used with regexMatch. + * Specifies that prefixMatch and fullPathMatch matches are case sensitive. The default value is false. ignoreCase must not be used with regexMatch. */ ignoreCase?: boolean | null; /** - * Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. metadataFilters specified here can be overrides those specified in ForwardingRule that refers to this UrlMap. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. + * Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. */ metadataFilters?: Schema$MetadataFilter[]; /** - * For satifying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. The value must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified. + * For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. The value must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified. */ prefixMatch?: string | null; /** @@ -4006,7 +4018,7 @@ export namespace compute_alpha { */ queryParameterMatches?: Schema$HttpQueryParameterMatch[]; /** - * For satifying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript Only one of prefixMatch, fullPathMatch or regexMatch must be specified. + * For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript Only one of prefixMatch, fullPathMatch or regexMatch must be specified. */ regexMatch?: string | null; } @@ -4506,7 +4518,7 @@ export namespace compute_alpha { } | null; } /** - * Represents an unmanaged Instance Group resource. Use unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. For more information, read Instance groups. For zonal unmanaged Instance Group, use instanceGroups resource. For regional unmanaged Instance Group, use regionInstanceGroups resource. (== resource_for beta.instanceGroups ==) (== resource_for v1.instanceGroups ==) (== resource_for beta.regionInstanceGroups ==) (== resource_for v1.regionInstanceGroups ==) + * Represents an Instance Group resource. Instance Groups can be used to configure a target for load balancing. Instance groups can either be managed or unmanaged. To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead. Use zonal unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. You cannot create regional unmanaged instance groups. For more information, read Instance groups. (== resource_for beta.instanceGroups ==) (== resource_for v1.instanceGroups ==) (== resource_for beta.regionInstanceGroups ==) (== resource_for v1.regionInstanceGroups ==) */ export interface Schema$InstanceGroup { /** @@ -5344,6 +5356,10 @@ export namespace compute_alpha { * Specifies the reservations that this instance can consume from. */ reservationAffinity?: Schema$ReservationAffinity; + /** + * Resource policies (names, not ULRs) applied to instances created from this templae. + */ + resourcePolicies?: string[] | null; /** * Specifies the scheduling options for the instances that are created from this template. */ @@ -6489,11 +6505,11 @@ export namespace compute_alpha { /** * Specifies the number of such disks. */ - diskCount?: string | null; + diskCount?: number | null; /** * Specifies the size of the disk in base-2 GB. */ - diskSizeGb?: string | null; + diskSizeGb?: number | null; /** * Specifies the desired disk type on the node. This disk type must be a local storage type (e.g.: local-ssd). Note that for nodeTemplates, this should be the name of the disk type and not its URL. */ @@ -6637,7 +6653,6 @@ export namespace compute_alpha { * A list of machine images. */ export interface Schema$MachineImageList { - etag?: string | null; /** * [Output Only] Unique identifier for the resource; defined by the server. */ @@ -6917,7 +6932,7 @@ export namespace compute_alpha { structConfig?: string | null; } /** - * Opaque filter criteria used by loadbalancers to restrict routing configuration to a limited set of loadbalancing proxies. Proxies and sidecars involved in loadbalancing would typically present metadata to the loadbalancers which need to match criteria specified here. If a match takes place, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. An example for using metadataFilters would be: if loadbalancing involves Envoys, they will only receive routing configuration when values in metadataFilters match values supplied in <a href="https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/core/base.proto#envoy-api-msg-core-node" Node metadata of their XDS requests to loadbalancers. + * Opaque filter criteria used by loadbalancers to restrict routing configuration to a limited set of loadbalancing proxies. Proxies and sidecars involved in loadbalancing would typically present metadata to the loadbalancers which need to match criteria specified here. If a match takes place, the relevant configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. An example for using metadataFilters would be: if loadbalancing involves Envoys, they will only receive routing configuration when values in metadataFilters match values supplied in <a href="https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/core/base.proto#envoy-api-msg-core-node" Node metadata of their XDS requests to loadbalancers. */ export interface Schema$MetadataFilter { /** @@ -7005,7 +7020,7 @@ export namespace compute_alpha { */ loadBalancerVmEncryption?: string | null; /** - * Maximum Transmission Unit in bytes. The minimum value for this field is 1460 and the maximum value is 1600 bytes. + * Maximum Transmission Unit in bytes. The minimum value for this field is 1460 and the maximum value is 1500 bytes. */ mtu?: number | null; /** @@ -7013,7 +7028,7 @@ export namespace compute_alpha { */ multicastMode?: string | null; /** - * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. */ name?: string | null; /** @@ -7038,7 +7053,7 @@ export namespace compute_alpha { subnetworks?: string[] | null; } /** - * The network endpoint. + * The network endpoint. Next ID: 7 */ export interface Schema$NetworkEndpoint { /** @@ -7063,7 +7078,7 @@ export namespace compute_alpha { port?: number | null; } /** - * Represents a collection of network endpoints. For more information read Setting up network endpoint groups in load balancing. (== resource_for v1.networkEndpointGroups ==) (== resource_for beta.networkEndpointGroups ==) + * Represents a collection of network endpoints. For more information read Setting up network endpoint groups in load balancing. (== resource_for v1.networkEndpointGroups ==) (== resource_for beta.networkEndpointGroups ==) Next ID: 21 */ export interface Schema$NetworkEndpointGroup { /** @@ -7545,9 +7560,12 @@ export namespace compute_alpha { networkPeering?: Schema$NetworkPeering; } /** - * Represent a sole-tenant Node Group resource. A sole-tenant node is a physical server that is dedicated to hosting VM instances only for your specific project. Use sole-tenant nodes to keep your instances physically separated from instances in other projects, or to group your instances together on the same host hardware. For more information, read Sole-tenant nodes. (== resource_for beta.nodeGroups ==) (== resource_for v1.nodeGroups ==) NextID: 16 + * Represent a sole-tenant Node Group resource. A sole-tenant node is a physical server that is dedicated to hosting VM instances only for your specific project. Use sole-tenant nodes to keep your instances physically separated from instances in other projects, or to group your instances together on the same host hardware. For more information, read Sole-tenant nodes. (== resource_for beta.nodeGroups ==) (== resource_for v1.nodeGroups ==) */ export interface Schema$NodeGroup { + /** + * Specifies how autoscaling should behave. + */ autoscalingPolicy?: Schema$NodeGroupAutoscalingPolicy; /** * [Output Only] Creation timestamp in RFC3339 text format. @@ -7557,6 +7575,7 @@ export namespace compute_alpha { * An optional description of this resource. Provide this property when you create the resource. */ description?: string | null; + fingerprint?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ @@ -7565,6 +7584,9 @@ export namespace compute_alpha { * [Output Only] The type of the resource. Always compute#nodeGroup for node group. */ kind?: string | null; + /** + * Specifies how to handle instances when a node in the group undergoes maintenance. + */ maintenancePolicy?: string | null; /** * 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. @@ -7623,8 +7645,17 @@ export namespace compute_alpha { } | null; } export interface Schema$NodeGroupAutoscalingPolicy { - maxSize?: number | null; - minSize?: number | null; + /** + * The maximum number of nodes that the group should have. + */ + maxNodes?: number | null; + /** + * The minimum number of nodes that the group should have. + */ + minNodes?: number | null; + /** + * The autoscaling mode. + */ mode?: string | null; } /** @@ -7753,7 +7784,7 @@ export namespace compute_alpha { nodeTemplate?: string | null; } /** - * Represent a sole-tenant Node Template resource. You can use a template to define properties for nodes in a node group. For more information, read Creating node groups and instances. (== resource_for beta.nodeTemplates ==) (== resource_for v1.nodeTemplates ==) (== NextID: 16 ==) + * Represent a sole-tenant Node Template resource. You can use a template to define properties for nodes in a node group. For more information, read Creating node groups and instances. (== resource_for beta.nodeTemplates ==) (== resource_for v1.nodeTemplates ==) */ export interface Schema$NodeTemplate { /** @@ -8351,7 +8382,7 @@ export namespace compute_alpha { */ enforcingSuccessRate?: number | null; /** - * Time interval between ejection sweep analysis. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 seconds. + * Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second. */ interval?: Schema$Duration; /** @@ -8408,10 +8439,6 @@ export namespace compute_alpha { * The Forwarding Rule resource of type loadBalancingScheme=INTERNAL that will be used as collector for mirrored traffic. The specified forwarding rule must have isMirroringCollector set to true. */ collectorIlb?: Schema$PacketMirroringForwardingRuleInfo; - /** - * PacketMirroring collectorInfos. Each collectorInfo specifies a set of collector VM instances, preferably in the same zone as the mirrored VM(s) - */ - collectors?: Schema$PacketMirroringCollectorInfo; /** * [Output Only] Creation timestamp in RFC3339 text format. */ @@ -8448,10 +8475,6 @@ export namespace compute_alpha { * Specifies the mirrored VPC network. Only packets in this network will be mirrored. All mirrored VMs should have a NIC in the given network. All mirrored subnetworks should belong to the given network. */ network?: Schema$PacketMirroringNetworkInfo; - /** - * PacketMirroring packetMatchers. Each packetMatcher specifies a CIRD filter that will apply to the source or destination IP in the IP header for the mirrored VM traffic. - */ - packetMatchers?: Schema$PacketMirroringPacketMatcher[]; /** * The priority of applying this configuration. Priority is used to break ties in cases where there is more than one matching rule. In the case of two rules that apply for a given Instance, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535. */ @@ -8502,18 +8525,6 @@ export namespace compute_alpha { message?: string; } | null; } - export interface Schema$PacketMirroringCollectorInfo { - /** - * A set of virtual machines configured as destination of the mirrored traffic. They must live in zones contained in the same region as this packetMirroring. - */ - instances?: Schema$PacketMirroringCollectorInfoInstanceInfo[]; - } - export interface Schema$PacketMirroringCollectorInfoInstanceInfo { - /** - * Resource URL to the virtual machine instance configured as destination of the mirrored traffic. - */ - url?: string | null; - } export interface Schema$PacketMirroringFilter { /** * IP CIDR ranges that apply as filter on the source (ingress) or destination (egress) IP in the IP header. Only IPv4 is supported. If no ranges are specified, all traffic that matches the specified IPProtocols is mirrored. If neither cidrRanges nor IPProtocols is specified, all traffic is mirrored. @@ -8611,12 +8622,6 @@ export namespace compute_alpha { */ url?: string | null; } - export interface Schema$PacketMirroringPacketMatcher { - /** - * IP CIDR range that applies as filter on the source or destination IP in the IP header. Only IPv4 is supported. - */ - cidrRange?: string | null; - } export interface Schema$PacketMirroringsScopedList { /** * A list of packetMirrorings contained in this scope. @@ -8644,7 +8649,7 @@ export namespace compute_alpha { */ defaultService?: string | null; /** - * When when none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. + * When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. */ defaultUrlRedirect?: Schema$HttpRedirectAction; /** @@ -8664,7 +8669,7 @@ export namespace compute_alpha { */ pathRules?: Schema$PathRule[]; /** - * The list of ordered HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. The order of specifying routeRules matters: the first rule that matches will cause its specified routing action to take effect. Within a given pathMatcher, only one of pathRules or routeRules must be set. routeRules are not supported in UrlMaps intended for External Load balancers. + * The list of HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number. Within a given pathMatcher, only one of pathRules or routeRules must be set. routeRules are not supported in UrlMaps intended for External Load balancers. */ routeRules?: Schema$HttpRouteRule[]; } @@ -8767,7 +8772,7 @@ export namespace compute_alpha { values?: string[] | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -8775,11 +8780,11 @@ export namespace compute_alpha { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if either of incoming or stored policy does not meet the version requirements. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; iamOwned?: boolean | null; @@ -8788,7 +8793,7 @@ export namespace compute_alpha { */ rules?: Schema$Rule[]; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a conditional binding from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, any version compliance checks on the incoming and/or stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } @@ -10051,9 +10056,9 @@ export namespace compute_alpha { */ availabilityDomainCount?: number | null; /** - * Distribution specifies how the instances are placed at host level. If set to SPREAD, no two instances will be put on the same host + * Specifies network collocation */ - distribution?: string | null; + collocation?: string | null; /** * Specifies network locality */ @@ -10861,6 +10866,10 @@ export namespace compute_alpha { * The size of the disk in base-2 GB. */ diskSizeGb?: string | null; + /** + * [Output Only] URL of the disk type resource. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd + */ + diskType?: string | null; /** * A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. */ @@ -11398,7 +11407,7 @@ export namespace compute_alpha { */ export interface Schema$Snapshot { /** - * [Output Only] Set to true if snapshots are automatically by applying resource policy on the target disk. + * [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk. */ autoCreated?: boolean | null; /** @@ -11413,6 +11422,10 @@ export namespace compute_alpha { * [Output Only] Size of the source disk, specified in GB. */ diskSizeGb?: string | null; + /** + * [Output Only] Number of bytes downloaded to restore a snapshot to a disk. + */ + downloadBytes?: string | null; /** * [Output Only] A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. */ @@ -11593,7 +11606,7 @@ export namespace compute_alpha { tags?: Schema$Tags; } /** - * Represents an SSL Certificate resource. This SSL certificate resource also contains a private key. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and Using SSL Certificates. (== resource_for beta.sslCertificates ==) (== resource_for v1.sslCertificates ==) + * Represents an SSL Certificate resource. This SSL certificate resource also contains a private key. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and Using SSL Certificates. (== resource_for beta.sslCertificates ==) (== resource_for v1.sslCertificates ==) (== resource_for beta.regionSslCertificates ==) (== resource_for v1.regionSslCertificates ==) Next ID: 17 */ export interface Schema$SslCertificate { /** @@ -12195,7 +12208,7 @@ export namespace compute_alpha { } | null; } /** - * Represents a Target HTTP Proxy resource. A target HTTP proxy is a component of certain types of load balancers. Global forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies. (== resource_for beta.targetHttpProxies ==) (== resource_for v1.targetHttpProxies ==) + * Represents a Target HTTP Proxy resource. A target HTTP proxy is a component of GCP HTTP load balancers. Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for beta.targetHttpProxies ==) (== resource_for v1.targetHttpProxies ==) (== resource_for beta.regionTargetHttpProxies ==) (== resource_for v1.regionTargetHttpProxies ==) */ export interface Schema$TargetHttpProxy { /** @@ -12329,7 +12342,7 @@ export namespace compute_alpha { sslCertificates?: string[] | null; } /** - * Represents a Target HTTPS Proxy resource. A target HTTPS proxy is a component of certain types of load balancers. Global forwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies. (== resource_for beta.targetHttpsProxies ==) (== resource_for v1.targetHttpsProxies ==) + * Represents a Target HTTPS Proxy resource. A target HTTPS proxy is a component of GCP HTTPS load balancers. Forwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for beta.targetHttpsProxies ==) (== resource_for v1.targetHttpsProxies ==) (== resource_for beta.regionTargetHttpsProxies ==) (== resource_for v1.regionTargetHttpsProxies ==) */ export interface Schema$TargetHttpsProxy { /** @@ -13533,7 +13546,7 @@ export namespace compute_alpha { } | null; } /** - * Represents a VPN gateway resource. + * Represents a VPN gateway resource. Next ID: 13 */ export interface Schema$VpnGateway { /** @@ -14100,12 +14113,13 @@ export namespace compute_alpha { /** * compute.acceleratorTypes.aggregatedList - * @desc Retrieves an aggregated list of accelerator types. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of accelerator types. * @alias compute.acceleratorTypes.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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. @@ -14187,7 +14201,7 @@ export namespace compute_alpha { /** * compute.acceleratorTypes.get - * @desc Returns the specified accelerator type. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified accelerator type. * @alias compute.acceleratorTypes.get * @memberOf! () * @@ -14263,7 +14277,7 @@ export namespace compute_alpha { /** * compute.acceleratorTypes.list - * @desc Retrieves a list of accelerator types available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of accelerator types available to the specified project. * @alias compute.acceleratorTypes.list * @memberOf! () * @@ -14352,6 +14366,10 @@ export namespace compute_alpha { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ @@ -14430,12 +14448,13 @@ export namespace compute_alpha { /** * compute.addresses.aggregatedList - * @desc Retrieves an aggregated list of addresses. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of addresses. * @alias compute.addresses.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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. @@ -14511,7 +14530,7 @@ export namespace compute_alpha { /** * compute.addresses.delete - * @desc Deletes the specified address resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified address resource. * @alias compute.addresses.delete * @memberOf! () * @@ -14587,7 +14606,7 @@ export namespace compute_alpha { /** * compute.addresses.get - * @desc Returns the specified address resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified address resource. * @alias compute.addresses.get * @memberOf! () * @@ -14660,7 +14679,7 @@ export namespace compute_alpha { /** * compute.addresses.insert - * @desc Creates an address resource in the specified project by using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates an address resource in the specified project by using the data included in the request. * @alias compute.addresses.insert * @memberOf! () * @@ -14736,7 +14755,7 @@ export namespace compute_alpha { /** * compute.addresses.list - * @desc Retrieves a list of addresses contained within the specified region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of addresses contained within the specified region. * @alias compute.addresses.list * @memberOf! () * @@ -14814,7 +14833,7 @@ export namespace compute_alpha { /** * compute.addresses.setLabels - * @desc Sets the labels on an Address. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the labels on an Address. To learn more about labels, read the Labeling Resources documentation. * @alias compute.addresses.setLabels * @memberOf! () * @@ -14892,7 +14911,7 @@ export namespace compute_alpha { /** * compute.addresses.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.addresses.testIamPermissions * @memberOf! () * @@ -14983,6 +15002,10 @@ export namespace compute_alpha { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ @@ -15160,12 +15183,13 @@ export namespace compute_alpha { /** * compute.autoscalers.aggregatedList - * @desc Retrieves an aggregated list of autoscalers. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of autoscalers. * @alias compute.autoscalers.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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. @@ -15242,7 +15266,7 @@ export namespace compute_alpha { /** * compute.autoscalers.delete - * @desc Deletes the specified autoscaler. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified autoscaler. * @alias compute.autoscalers.delete * @memberOf! () * @@ -15319,7 +15343,7 @@ export namespace compute_alpha { /** * compute.autoscalers.get - * @desc Returns the specified autoscaler resource. Gets a list of available autoscalers by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified autoscaler resource. Gets a list of available autoscalers by making a list() request. * @alias compute.autoscalers.get * @memberOf! () * @@ -15394,7 +15418,7 @@ export namespace compute_alpha { /** * compute.autoscalers.insert - * @desc Creates an autoscaler in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates an autoscaler in the specified project using the data included in the request. * @alias compute.autoscalers.insert * @memberOf! () * @@ -15471,7 +15495,7 @@ export namespace compute_alpha { /** * compute.autoscalers.list - * @desc Retrieves a list of autoscalers contained within the specified zone. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of autoscalers contained within the specified zone. * @alias compute.autoscalers.list * @memberOf! () * @@ -15549,7 +15573,7 @@ export namespace compute_alpha { /** * compute.autoscalers.patch - * @desc Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.autoscalers.patch * @memberOf! () * @@ -15627,7 +15651,7 @@ export namespace compute_alpha { /** * compute.autoscalers.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.autoscalers.testIamPermissions * @memberOf! () * @@ -15708,7 +15732,7 @@ export namespace compute_alpha { /** * compute.autoscalers.update - * @desc Updates an autoscaler in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Updates an autoscaler in the specified project using the data included in the request. * @alias compute.autoscalers.update * @memberOf! () * @@ -15796,6 +15820,10 @@ export namespace compute_alpha { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ @@ -16004,7 +16032,7 @@ export namespace compute_alpha { /** * compute.backendBuckets.addSignedUrlKey - * @desc Adds a key for validating requests with signed URLs for this backend bucket. (== suppress_warning http-rest-shadowed ==) + * @desc Adds a key for validating requests with signed URLs for this backend bucket. * @alias compute.backendBuckets.addSignedUrlKey * @memberOf! () * @@ -16081,7 +16109,7 @@ export namespace compute_alpha { /** * compute.backendBuckets.delete - * @desc Deletes the specified BackendBucket resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified BackendBucket resource. * @alias compute.backendBuckets.delete * @memberOf! () * @@ -16157,7 +16185,7 @@ export namespace compute_alpha { /** * compute.backendBuckets.deleteSignedUrlKey - * @desc Deletes a key for validating requests with signed URLs for this backend bucket. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes a key for validating requests with signed URLs for this backend bucket. * @alias compute.backendBuckets.deleteSignedUrlKey * @memberOf! () * @@ -16234,7 +16262,7 @@ export namespace compute_alpha { /** * compute.backendBuckets.get - * @desc Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request. * @alias compute.backendBuckets.get * @memberOf! () * @@ -16309,7 +16337,7 @@ export namespace compute_alpha { /** * compute.backendBuckets.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.backendBuckets.getIamPolicy * @memberOf! () * @@ -16383,7 +16411,7 @@ export namespace compute_alpha { /** * compute.backendBuckets.insert - * @desc Creates a BackendBucket resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a BackendBucket resource in the specified project using the data included in the request. * @alias compute.backendBuckets.insert * @memberOf! () * @@ -16459,7 +16487,7 @@ export namespace compute_alpha { /** * compute.backendBuckets.list - * @desc Retrieves the list of BackendBucket resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of BackendBucket resources available to the specified project. * @alias compute.backendBuckets.list * @memberOf! () * @@ -16537,7 +16565,7 @@ export namespace compute_alpha { /** * compute.backendBuckets.patch - * @desc Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.backendBuckets.patch * @memberOf! () * @@ -16614,7 +16642,7 @@ export namespace compute_alpha { /** * compute.backendBuckets.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.backendBuckets.setIamPolicy * @memberOf! () * @@ -16688,7 +16716,7 @@ export namespace compute_alpha { /** * compute.backendBuckets.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.backendBuckets.testIamPermissions * @memberOf! () * @@ -16768,7 +16796,7 @@ export namespace compute_alpha { /** * compute.backendBuckets.update - * @desc Updates the specified BackendBucket resource with the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified BackendBucket resource with the data included in the request. * @alias compute.backendBuckets.update * @memberOf! () * @@ -17099,7 +17127,7 @@ export namespace compute_alpha { /** * compute.backendServices.addSignedUrlKey - * @desc Adds a key for validating requests with signed URLs for this backend service. (== suppress_warning http-rest-shadowed ==) + * @desc Adds a key for validating requests with signed URLs for this backend service. * @alias compute.backendServices.addSignedUrlKey * @memberOf! () * @@ -17176,12 +17204,13 @@ export namespace compute_alpha { /** * compute.backendServices.aggregatedList - * @desc Retrieves the list of all BackendService resources, regional and global, available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of all BackendService resources, regional and global, available to the specified project. * @alias compute.backendServices.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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. @@ -17263,7 +17292,7 @@ export namespace compute_alpha { /** * compute.backendServices.delete - * @desc Deletes the specified BackendService resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified BackendService resource. * @alias compute.backendServices.delete * @memberOf! () * @@ -17339,7 +17368,7 @@ export namespace compute_alpha { /** * compute.backendServices.deleteSignedUrlKey - * @desc Deletes a key for validating requests with signed URLs for this backend service. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes a key for validating requests with signed URLs for this backend service. * @alias compute.backendServices.deleteSignedUrlKey * @memberOf! () * @@ -17416,7 +17445,7 @@ export namespace compute_alpha { /** * compute.backendServices.get - * @desc Returns the specified BackendService resource. Gets a list of available backend services. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified BackendService resource. Gets a list of available backend services. * @alias compute.backendServices.get * @memberOf! () * @@ -17491,7 +17520,7 @@ export namespace compute_alpha { /** * compute.backendServices.getHealth - * @desc Gets the most recent health check results for this BackendService. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the most recent health check results for this BackendService. * @alias compute.backendServices.getHealth * @memberOf! () * @@ -17574,7 +17603,7 @@ export namespace compute_alpha { /** * compute.backendServices.insert - * @desc Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information. * @alias compute.backendServices.insert * @memberOf! () * @@ -17650,7 +17679,7 @@ export namespace compute_alpha { /** * compute.backendServices.list - * @desc Retrieves the list of BackendService resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of BackendService resources available to the specified project. * @alias compute.backendServices.list * @memberOf! () * @@ -17728,7 +17757,7 @@ export namespace compute_alpha { /** * compute.backendServices.patch - * @desc Patches the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Patches the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.backendServices.patch * @memberOf! () * @@ -17805,7 +17834,7 @@ export namespace compute_alpha { /** * compute.backendServices.setSecurityPolicy - * @desc Sets the security policy for the specified backend service. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the security policy for the specified backend service. * @alias compute.backendServices.setSecurityPolicy * @memberOf! () * @@ -17882,7 +17911,7 @@ export namespace compute_alpha { /** * compute.backendServices.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.backendServices.testIamPermissions * @memberOf! () * @@ -17962,7 +17991,7 @@ export namespace compute_alpha { /** * compute.backendServices.update - * @desc Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. * @alias compute.backendServices.update * @memberOf! () * @@ -18074,6 +18103,10 @@ export namespace compute_alpha { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ @@ -18326,7 +18359,7 @@ export namespace compute_alpha { /** * compute.disks.addResourcePolicies - * @desc Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation. (== suppress_warning http-rest-shadowed ==) + * @desc Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation. * @alias compute.disks.addResourcePolicies * @memberOf! () * @@ -18404,12 +18437,13 @@ export namespace compute_alpha { /** * compute.disks.aggregatedList - * @desc Retrieves an aggregated list of persistent disks. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of persistent disks. * @alias compute.disks.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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. @@ -18483,7 +18517,7 @@ export namespace compute_alpha { /** * compute.disks.createSnapshot - * @desc Creates a snapshot of a specified persistent disk. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a snapshot of a specified persistent disk. * @alias compute.disks.createSnapshot * @memberOf! () * @@ -18562,7 +18596,7 @@ export namespace compute_alpha { /** * compute.disks.delete - * @desc Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. * @alias compute.disks.delete * @memberOf! () * @@ -18638,7 +18672,7 @@ export namespace compute_alpha { /** * compute.disks.get - * @desc Returns a specified persistent disk. Gets a list of available persistent disks by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns a specified persistent disk. Gets a list of available persistent disks by making a list() request. * @alias compute.disks.get * @memberOf! () * @@ -18711,7 +18745,7 @@ export namespace compute_alpha { /** * compute.disks.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.disks.getIamPolicy * @memberOf! () * @@ -18786,7 +18820,7 @@ export namespace compute_alpha { /** * compute.disks.insert - * @desc Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property. * @alias compute.disks.insert * @memberOf! () * @@ -18862,7 +18896,7 @@ export namespace compute_alpha { /** * compute.disks.list - * @desc Retrieves a list of persistent disks contained within the specified zone. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of persistent disks contained within the specified zone. * @alias compute.disks.list * @memberOf! () * @@ -18937,7 +18971,7 @@ export namespace compute_alpha { /** * compute.disks.removeResourcePolicies - * @desc Removes resource policies from a disk. (== suppress_warning http-rest-shadowed ==) + * @desc Removes resource policies from a disk. * @alias compute.disks.removeResourcePolicies * @memberOf! () * @@ -19017,7 +19051,7 @@ export namespace compute_alpha { /** * compute.disks.resize - * @desc Resizes the specified persistent disk. You can only increase the size of the disk. (== suppress_warning http-rest-shadowed ==) + * @desc Resizes the specified persistent disk. You can only increase the size of the disk. * @alias compute.disks.resize * @memberOf! () * @@ -19094,7 +19128,7 @@ export namespace compute_alpha { /** * compute.disks.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.disks.setIamPolicy * @memberOf! () * @@ -19169,7 +19203,7 @@ export namespace compute_alpha { /** * compute.disks.setLabels - * @desc Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation. * @alias compute.disks.setLabels * @memberOf! () * @@ -19246,7 +19280,7 @@ export namespace compute_alpha { /** * compute.disks.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.disks.testIamPermissions * @memberOf! () * @@ -19366,6 +19400,10 @@ export namespace compute_alpha { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ @@ -19685,12 +19723,13 @@ export namespace compute_alpha { /** * compute.diskTypes.aggregatedList - * @desc Retrieves an aggregated list of disk types. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of disk types. * @alias compute.diskTypes.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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. @@ -19766,7 +19805,7 @@ export namespace compute_alpha { /** * compute.diskTypes.get - * @desc Returns the specified disk type. Gets a list of available disk types by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified disk type. Gets a list of available disk types by making a list() request. * @alias compute.diskTypes.get * @memberOf! () * @@ -19839,7 +19878,7 @@ export namespace compute_alpha { /** * compute.diskTypes.list - * @desc Retrieves a list of disk types available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of disk types available to the specified project. * @alias compute.diskTypes.list * @memberOf! () * @@ -19927,6 +19966,10 @@ export namespace compute_alpha { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ @@ -20003,7 +20046,7 @@ export namespace compute_alpha { /** * compute.externalVpnGateways.delete - * @desc Deletes the specified externalVpnGateway. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified externalVpnGateway. * @alias compute.externalVpnGateways.delete * @memberOf! () * @@ -20079,7 +20122,7 @@ export namespace compute_alpha { /** * compute.externalVpnGateways.get - * @desc Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request. * @alias compute.externalVpnGateways.get * @memberOf! () * @@ -20154,7 +20197,7 @@ export namespace compute_alpha { /** * compute.externalVpnGateways.insert - * @desc Creates a ExternalVpnGateway in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a ExternalVpnGateway in the specified project using the data included in the request. * @alias compute.externalVpnGateways.insert * @memberOf! () * @@ -20230,7 +20273,7 @@ export namespace compute_alpha { /** * compute.externalVpnGateways.list - * @desc Retrieves the list of ExternalVpnGateway available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of ExternalVpnGateway available to the specified project. * @alias compute.externalVpnGateways.list * @memberOf! () * @@ -20310,7 +20353,7 @@ export namespace compute_alpha { /** * compute.externalVpnGateways.setLabels - * @desc Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation. * @alias compute.externalVpnGateways.setLabels * @memberOf! () * @@ -20386,7 +20429,7 @@ export namespace compute_alpha { /** * compute.externalVpnGateways.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.externalVpnGateways.testIamPermissions * @memberOf! () * @@ -20601,7 +20644,7 @@ export namespace compute_alpha { /** * compute.firewalls.delete - * @desc Deletes the specified firewall. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified firewall. * @alias compute.firewalls.delete * @memberOf! () * @@ -20676,7 +20719,7 @@ export namespace compute_alpha { /** * compute.firewalls.get - * @desc Returns the specified firewall. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified firewall. * @alias compute.firewalls.get * @memberOf! () * @@ -20748,7 +20791,7 @@ export namespace compute_alpha { /** * compute.firewalls.insert - * @desc Creates a firewall rule in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a firewall rule in the specified project using the data included in the request. * @alias compute.firewalls.insert * @memberOf! () * @@ -20822,7 +20865,7 @@ export namespace compute_alpha { /** * compute.firewalls.list - * @desc Retrieves the list of firewall rules available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of firewall rules available to the specified project. * @alias compute.firewalls.list * @memberOf! () * @@ -20898,7 +20941,7 @@ export namespace compute_alpha { /** * compute.firewalls.patch - * @desc Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.firewalls.patch * @memberOf! () * @@ -20974,7 +21017,7 @@ export namespace compute_alpha { /** * compute.firewalls.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.firewalls.testIamPermissions * @memberOf! () * @@ -21054,7 +21097,7 @@ export namespace compute_alpha { /** * compute.firewalls.update - * @desc Updates the specified firewall rule with the data included in the request. Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified firewall rule with the data included in the request. Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead. * @alias compute.firewalls.update * @memberOf! () * @@ -21288,12 +21331,13 @@ export namespace compute_alpha { /** * compute.forwardingRules.aggregatedList - * @desc Retrieves an aggregated list of forwarding rules. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of forwarding rules. * @alias compute.forwardingRules.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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. @@ -21375,7 +21419,7 @@ export namespace compute_alpha { /** * compute.forwardingRules.delete - * @desc Deletes the specified ForwardingRule resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified ForwardingRule resource. * @alias compute.forwardingRules.delete * @memberOf! () * @@ -21452,7 +21496,7 @@ export namespace compute_alpha { /** * compute.forwardingRules.get - * @desc Returns the specified ForwardingRule resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified ForwardingRule resource. * @alias compute.forwardingRules.get * @memberOf! () * @@ -21528,7 +21572,7 @@ export namespace compute_alpha { /** * compute.forwardingRules.insert - * @desc Creates a ForwardingRule resource in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a ForwardingRule resource in the specified project and region using the data included in the request. * @alias compute.forwardingRules.insert * @memberOf! () * @@ -21605,7 +21649,7 @@ export namespace compute_alpha { /** * compute.forwardingRules.list - * @desc Retrieves a list of ForwardingRule resources available to the specified project and region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of ForwardingRule resources available to the specified project and region. * @alias compute.forwardingRules.list * @memberOf! () * @@ -21684,7 +21728,7 @@ export namespace compute_alpha { /** * compute.forwardingRules.patch - * @desc Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field. * @alias compute.forwardingRules.patch * @memberOf! () * @@ -21762,7 +21806,7 @@ export namespace compute_alpha { /** * compute.forwardingRules.setLabels - * @desc Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation. * @alias compute.forwardingRules.setLabels * @memberOf! () * @@ -21840,7 +21884,7 @@ export namespace compute_alpha { /** * compute.forwardingRules.setTarget - * @desc Changes target URL for forwarding rule. The new target should be of the same type as the old target. (== suppress_warning http-rest-shadowed ==) + * @desc Changes target URL for forwarding rule. The new target should be of the same type as the old target. * @alias compute.forwardingRules.setTarget * @memberOf! () * @@ -21918,7 +21962,7 @@ export namespace compute_alpha { /** * compute.forwardingRules.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.forwardingRules.testIamPermissions * @memberOf! () * @@ -22009,6 +22053,10 @@ export namespace compute_alpha { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ @@ -22248,7 +22296,7 @@ export namespace compute_alpha { /** * compute.globalAddresses.delete - * @desc Deletes the specified address resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified address resource. * @alias compute.globalAddresses.delete * @memberOf! () * @@ -22324,7 +22372,7 @@ export namespace compute_alpha { /** * compute.globalAddresses.get - * @desc Returns the specified address resource. Gets a list of available addresses by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified address resource. Gets a list of available addresses by making a list() request. * @alias compute.globalAddresses.get * @memberOf! () * @@ -22397,7 +22445,7 @@ export namespace compute_alpha { /** * compute.globalAddresses.insert - * @desc Creates an address resource in the specified project by using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates an address resource in the specified project by using the data included in the request. * @alias compute.globalAddresses.insert * @memberOf! () * @@ -22472,7 +22520,7 @@ export namespace compute_alpha { /** * compute.globalAddresses.list - * @desc Retrieves a list of global addresses. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of global addresses. * @alias compute.globalAddresses.list * @memberOf! () * @@ -22549,7 +22597,7 @@ export namespace compute_alpha { /** * compute.globalAddresses.setLabels - * @desc Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation. * @alias compute.globalAddresses.setLabels * @memberOf! () * @@ -22625,7 +22673,7 @@ export namespace compute_alpha { /** * compute.globalAddresses.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.globalAddresses.testIamPermissions * @memberOf! () * @@ -22840,7 +22888,7 @@ export namespace compute_alpha { /** * compute.globalForwardingRules.delete - * @desc Deletes the specified GlobalForwardingRule resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified GlobalForwardingRule resource. * @alias compute.globalForwardingRules.delete * @memberOf! () * @@ -22916,7 +22964,7 @@ export namespace compute_alpha { /** * compute.globalForwardingRules.get - * @desc Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request. * @alias compute.globalForwardingRules.get * @memberOf! () * @@ -22991,7 +23039,7 @@ export namespace compute_alpha { /** * compute.globalForwardingRules.insert - * @desc Creates a GlobalForwardingRule resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a GlobalForwardingRule resource in the specified project using the data included in the request. * @alias compute.globalForwardingRules.insert * @memberOf! () * @@ -23067,7 +23115,7 @@ export namespace compute_alpha { /** * compute.globalForwardingRules.list - * @desc Retrieves a list of GlobalForwardingRule resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of GlobalForwardingRule resources available to the specified project. * @alias compute.globalForwardingRules.list * @memberOf! () * @@ -23145,7 +23193,7 @@ export namespace compute_alpha { /** * compute.globalForwardingRules.patch - * @desc Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field. * @alias compute.globalForwardingRules.patch * @memberOf! () * @@ -23222,7 +23270,7 @@ export namespace compute_alpha { /** * compute.globalForwardingRules.setLabels - * @desc Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation. * @alias compute.globalForwardingRules.setLabels * @memberOf! () * @@ -23298,7 +23346,7 @@ export namespace compute_alpha { /** * compute.globalForwardingRules.setTarget - * @desc Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target. (== suppress_warning http-rest-shadowed ==) + * @desc Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target. * @alias compute.globalForwardingRules.setTarget * @memberOf! () * @@ -23375,7 +23423,7 @@ export namespace compute_alpha { /** * compute.globalForwardingRules.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.globalForwardingRules.testIamPermissions * @memberOf! () * @@ -23640,7 +23688,7 @@ export namespace compute_alpha { /** * compute.globalNetworkEndpointGroups.attachNetworkEndpoints - * @desc Attach a network endpoint to the specified network endpoint group. (== suppress_warning http-rest-shadowed ==) + * @desc Attach a network endpoint to the specified network endpoint group. * @alias compute.globalNetworkEndpointGroups.attachNetworkEndpoints * @memberOf! () * @@ -23719,7 +23767,7 @@ export namespace compute_alpha { /** * compute.globalNetworkEndpointGroups.delete - * @desc Deletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it. * @alias compute.globalNetworkEndpointGroups.delete * @memberOf! () * @@ -23795,7 +23843,7 @@ export namespace compute_alpha { /** * compute.globalNetworkEndpointGroups.detachNetworkEndpoints - * @desc Detach the network endpoint from the specified network endpoint group. (== suppress_warning http-rest-shadowed ==) + * @desc Detach the network endpoint from the specified network endpoint group. * @alias compute.globalNetworkEndpointGroups.detachNetworkEndpoints * @memberOf! () * @@ -23874,7 +23922,7 @@ export namespace compute_alpha { /** * compute.globalNetworkEndpointGroups.get - * @desc Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request. * @alias compute.globalNetworkEndpointGroups.get * @memberOf! () * @@ -23951,7 +23999,7 @@ export namespace compute_alpha { /** * compute.globalNetworkEndpointGroups.insert - * @desc Creates a network endpoint group in the specified project using the parameters that are included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a network endpoint group in the specified project using the parameters that are included in the request. * @alias compute.globalNetworkEndpointGroups.insert * @memberOf! () * @@ -24027,7 +24075,7 @@ export namespace compute_alpha { /** * compute.globalNetworkEndpointGroups.list - * @desc Retrieves the list of network endpoint groups that are located in the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of network endpoint groups that are located in the specified project. * @alias compute.globalNetworkEndpointGroups.list * @memberOf! () * @@ -24107,7 +24155,7 @@ export namespace compute_alpha { /** * compute.globalNetworkEndpointGroups.listNetworkEndpoints - * @desc Lists the network endpoints in the specified network endpoint group. (== suppress_warning http-rest-shadowed ==) + * @desc Lists the network endpoints in the specified network endpoint group. * @alias compute.globalNetworkEndpointGroups.listNetworkEndpoints * @memberOf! () * @@ -24384,12 +24432,13 @@ export namespace compute_alpha { /** * compute.globalOperations.aggregatedList - * @desc Retrieves an aggregated list of all operations. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of all operations. * @alias compute.globalOperations.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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. @@ -24466,7 +24515,7 @@ export namespace compute_alpha { /** * compute.globalOperations.delete - * @desc Deletes the specified Operations resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified Operations resource. * @alias compute.globalOperations.delete * @memberOf! () * @@ -24539,7 +24588,7 @@ export namespace compute_alpha { /** * compute.globalOperations.get - * @desc Retrieves the specified Operations resource. Gets a list of operations by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the specified Operations resource. Gets a list of operations by making a list() request. * @alias compute.globalOperations.get * @memberOf! () * @@ -24614,7 +24663,7 @@ export namespace compute_alpha { /** * compute.globalOperations.list - * @desc Retrieves a list of Operation resources contained within the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of Operation resources contained within the specified project. * @alias compute.globalOperations.list * @memberOf! () * @@ -24691,7 +24740,7 @@ export namespace compute_alpha { /** * compute.globalOperations.wait - * @desc Waits for the specified Operations resource until it is done or timeout, and retrieves the specified Operations resource. 1. Immediately returns when the operation is already done. 2. Waits for no more than the default deadline (2 minutes, subject to change) and then returns the current state of the operation, which may be DONE or still in progress. 3. Is best-effort: a. The server can wait less than the default deadline or zero seconds, in overload situations. b. There is no guarantee that the operation is actually done when returns. 4. User should be prepared to retry if the operation is not DONE. (== suppress_warning http-rest-shadowed ==) + * @desc Waits for the specified Operations resource until it is done or timeout, and retrieves the specified Operations resource. 1. Immediately returns when the operation is already done. 2. Waits for no more than the default deadline (2 minutes, subject to change) and then returns the current state of the operation, which may be DONE or still in progress. 3. Is best-effort: a. The server can wait less than the default deadline or zero seconds, in overload situations. b. There is no guarantee that the operation is actually done when returns. 4. User should be prepared to retry if the operation is not DONE. * @alias compute.globalOperations.wait * @memberOf! () * @@ -24776,6 +24825,10 @@ export namespace compute_alpha { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ @@ -24878,7 +24931,7 @@ export namespace compute_alpha { /** * compute.globalOrganizationOperations.delete - * @desc Deletes the specified Operations resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified Operations resource. * @alias compute.globalOrganizationOperations.delete * @memberOf! () * @@ -24951,7 +25004,7 @@ export namespace compute_alpha { /** * compute.globalOrganizationOperations.get - * @desc Retrieves the specified Operations resource. Gets a list of operations by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the specified Operations resource. Gets a list of operations by making a list() request. * @alias compute.globalOrganizationOperations.get * @memberOf! () * @@ -25026,7 +25079,7 @@ export namespace compute_alpha { /** * compute.globalOrganizationOperations.list - * @desc Retrieves a list of Operation resources contained within the specified organization. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of Operation resources contained within the specified organization. * @alias compute.globalOrganizationOperations.list * @memberOf! () * @@ -25103,7 +25156,7 @@ export namespace compute_alpha { /** * compute.globalOrganizationOperations.wait - * @desc Waits for the specified Operations resource until it is done or timeout, and retrieves the specified Operations resource. 1. Immediately returns when the operation is already done. 2. Waits for no more than the default deadline (2 minutes, subject to change) and then returns the current state of the operation, which may be DONE or still in progress. 3. Is best-effort: a. The server can wait less than the default deadline or zero seconds, in overload situations. b. There is no guarantee that the operation is actually done when returns. 4. User should be prepared to retry if the operation is not DONE. (== suppress_warning http-rest-shadowed ==) + * @desc Waits for the specified Operations resource until it is done or timeout, and retrieves the specified Operations resource. 1. Immediately returns when the operation is already done. 2. Waits for no more than the default deadline (2 minutes, subject to change) and then returns the current state of the operation, which may be DONE or still in progress. 3. Is best-effort: a. The server can wait less than the default deadline or zero seconds, in overload situations. b. There is no guarantee that the operation is actually done when returns. 4. User should be prepared to retry if the operation is not DONE. * @alias compute.globalOrganizationOperations.wait * @memberOf! () * @@ -25262,7 +25315,7 @@ export namespace compute_alpha { /** * compute.globalPublicDelegatedPrefixes.delete - * @desc Deletes the specified global PublicDelegatedPrefix. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified global PublicDelegatedPrefix. * @alias compute.globalPublicDelegatedPrefixes.delete * @memberOf! () * @@ -25338,7 +25391,7 @@ export namespace compute_alpha { /** * compute.globalPublicDelegatedPrefixes.get - * @desc Returns the specified global PublicDelegatedPrefix resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified global PublicDelegatedPrefix resource. * @alias compute.globalPublicDelegatedPrefixes.get * @memberOf! () * @@ -25415,7 +25468,7 @@ export namespace compute_alpha { /** * compute.globalPublicDelegatedPrefixes.insert - * @desc Creates a global PublicDelegatedPrefix in the specified project using the parameters that are included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a global PublicDelegatedPrefix in the specified project using the parameters that are included in the request. * @alias compute.globalPublicDelegatedPrefixes.insert * @memberOf! () * @@ -25491,7 +25544,7 @@ export namespace compute_alpha { /** * compute.globalPublicDelegatedPrefixes.list - * @desc Lists the global PublicDelegatedPrefixes for a project. (== suppress_warning http-rest-shadowed ==) + * @desc Lists the global PublicDelegatedPrefixes for a project. * @alias compute.globalPublicDelegatedPrefixes.list * @memberOf! () * @@ -25576,7 +25629,7 @@ export namespace compute_alpha { /** * compute.globalPublicDelegatedPrefixes.patch - * @desc Patches the specified global PublicDelegatedPrefix resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Patches the specified global PublicDelegatedPrefix resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. * @alias compute.globalPublicDelegatedPrefixes.patch * @memberOf! () * @@ -25771,12 +25824,13 @@ export namespace compute_alpha { /** * compute.healthChecks.aggregatedList - * @desc Retrieves the list of all HealthCheck resources, regional and global, available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of all HealthCheck resources, regional and global, available to the specified project. * @alias compute.healthChecks.aggregatedList * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. @@ -25856,7 +25910,7 @@ export namespace compute_alpha { /** * compute.healthChecks.delete - * @desc Deletes the specified HealthCheck resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified HealthCheck resource. * @alias compute.healthChecks.delete * @memberOf! () * @@ -25932,7 +25986,7 @@ export namespace compute_alpha { /** * compute.healthChecks.get - * @desc Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. * @alias compute.healthChecks.get * @memberOf! () * @@ -26006,7 +26060,7 @@ export namespace compute_alpha { /** * compute.healthChecks.insert - * @desc Creates a HealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a HealthCheck resource in the specified project using the data included in the request. * @alias compute.healthChecks.insert * @memberOf! () * @@ -26081,7 +26135,7 @@ export namespace compute_alpha { /** * compute.healthChecks.list - * @desc Retrieves the list of HealthCheck resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of HealthCheck resources available to the specified project. * @alias compute.healthChecks.list * @memberOf! () * @@ -26158,7 +26212,7 @@ export namespace compute_alpha { /** * compute.healthChecks.patch - * @desc Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.healthChecks.patch * @memberOf! () * @@ -26235,7 +26289,7 @@ export namespace compute_alpha { /** * compute.healthChecks.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.healthChecks.testIamPermissions * @memberOf! () * @@ -26315,7 +26369,7 @@ export namespace compute_alpha { /** * compute.healthChecks.update - * @desc Updates a HealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. * @alias compute.healthChecks.update * @memberOf! () * @@ -26402,6 +26456,10 @@ export namespace compute_alpha { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ @@ -26583,7 +26641,7 @@ export namespace compute_alpha { /** * compute.httpHealthChecks.delete - * @desc Deletes the specified HttpHealthCheck resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified HttpHealthCheck resource. * @alias compute.httpHealthChecks.delete * @memberOf! () * @@ -26659,7 +26717,7 @@ export namespace compute_alpha { /** * compute.httpHealthChecks.get - * @desc Returns the specified HttpHealthCheck resource. Gets a list of available HTTP health checks by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified HttpHealthCheck resource. Gets a list of available HTTP health checks by making a list() request. * @alias compute.httpHealthChecks.get * @memberOf! () * @@ -26734,7 +26792,7 @@ export namespace compute_alpha { /** * compute.httpHealthChecks.insert - * @desc Creates a HttpHealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a HttpHealthCheck resource in the specified project using the data included in the request. * @alias compute.httpHealthChecks.insert * @memberOf! () * @@ -26810,7 +26868,7 @@ export namespace compute_alpha { /** * compute.httpHealthChecks.list - * @desc Retrieves the list of HttpHealthCheck resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of HttpHealthCheck resources available to the specified project. * @alias compute.httpHealthChecks.list * @memberOf! () * @@ -26888,7 +26946,7 @@ export namespace compute_alpha { /** * compute.httpHealthChecks.patch - * @desc Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.httpHealthChecks.patch * @memberOf! () * @@ -26965,7 +27023,7 @@ export namespace compute_alpha { /** * compute.httpHealthChecks.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.httpHealthChecks.testIamPermissions * @memberOf! () * @@ -27045,7 +27103,7 @@ export namespace compute_alpha { /** * compute.httpHealthChecks.update - * @desc Updates a HttpHealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Updates a HttpHealthCheck resource in the specified project using the data included in the request. * @alias compute.httpHealthChecks.update * @memberOf! () * @@ -27286,7 +27344,7 @@ export namespace compute_alpha { /** * compute.httpsHealthChecks.delete - * @desc Deletes the specified HttpsHealthCheck resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified HttpsHealthCheck resource. * @alias compute.httpsHealthChecks.delete * @memberOf! () * @@ -27362,7 +27420,7 @@ export namespace compute_alpha { /** * compute.httpsHealthChecks.get - * @desc Returns the specified HttpsHealthCheck resource. Gets a list of available HTTPS health checks by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified HttpsHealthCheck resource. Gets a list of available HTTPS health checks by making a list() request. * @alias compute.httpsHealthChecks.get * @memberOf! () * @@ -27437,7 +27495,7 @@ export namespace compute_alpha { /** * compute.httpsHealthChecks.insert - * @desc Creates a HttpsHealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a HttpsHealthCheck resource in the specified project using the data included in the request. * @alias compute.httpsHealthChecks.insert * @memberOf! () * @@ -27513,7 +27571,7 @@ export namespace compute_alpha { /** * compute.httpsHealthChecks.list - * @desc Retrieves the list of HttpsHealthCheck resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of HttpsHealthCheck resources available to the specified project. * @alias compute.httpsHealthChecks.list * @memberOf! () * @@ -27593,7 +27651,7 @@ export namespace compute_alpha { /** * compute.httpsHealthChecks.patch - * @desc Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.httpsHealthChecks.patch * @memberOf! () * @@ -27670,7 +27728,7 @@ export namespace compute_alpha { /** * compute.httpsHealthChecks.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.httpsHealthChecks.testIamPermissions * @memberOf! () * @@ -27750,7 +27808,7 @@ export namespace compute_alpha { /** * compute.httpsHealthChecks.update - * @desc Updates a HttpsHealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Updates a HttpsHealthCheck resource in the specified project using the data included in the request. * @alias compute.httpsHealthChecks.update * @memberOf! () * @@ -27991,7 +28049,7 @@ export namespace compute_alpha { /** * compute.images.delete - * @desc Deletes the specified image. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified image. * @alias compute.images.delete * @memberOf! () * @@ -28066,7 +28124,7 @@ export namespace compute_alpha { /** * compute.images.deprecate - * @desc Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead. * @alias compute.images.deprecate * @memberOf! () * @@ -28142,7 +28200,7 @@ export namespace compute_alpha { /** * compute.images.get - * @desc Returns the specified image. Gets a list of available images by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified image. Gets a list of available images by making a list() request. * @alias compute.images.get * @memberOf! () * @@ -28214,7 +28272,7 @@ export namespace compute_alpha { /** * compute.images.getFromFamily - * @desc Returns the latest image that is part of an image family and is not deprecated. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the latest image that is part of an image family and is not deprecated. * @alias compute.images.getFromFamily * @memberOf! () * @@ -28287,7 +28345,7 @@ export namespace compute_alpha { /** * compute.images.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.images.getIamPolicy * @memberOf! () * @@ -28361,7 +28419,7 @@ export namespace compute_alpha { /** * compute.images.insert - * @desc Creates an image in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates an image in the specified project using the data included in the request. * @alias compute.images.insert * @memberOf! () * @@ -28436,7 +28494,7 @@ export namespace compute_alpha { /** * compute.images.list - * @desc Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. * @alias compute.images.list * @memberOf! () * @@ -28512,7 +28570,7 @@ export namespace compute_alpha { /** * compute.images.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.images.setIamPolicy * @memberOf! () * @@ -28586,7 +28644,7 @@ export namespace compute_alpha { /** * compute.images.setLabels - * @desc Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation. * @alias compute.images.setLabels * @memberOf! () * @@ -28661,7 +28719,7 @@ export namespace compute_alpha { /** * compute.images.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.images.testIamPermissions * @memberOf! () * @@ -28956,7 +29014,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.abandonInstances - * @desc Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. (== suppress_warning http-rest-shadowed ==) + * @desc Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @alias compute.instanceGroupManagers.abandonInstances * @memberOf! () * @@ -29034,12 +29092,13 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.aggregatedList - * @desc Retrieves the list of managed instance groups and groups them by zone. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of managed instance groups and groups them by zone. * @alias compute.instanceGroupManagers.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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. @@ -29121,7 +29180,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.applyUpdatesToInstances - * @desc Apply changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions. (== suppress_warning http-rest-shadowed ==) + * @desc Apply changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions. * @alias compute.instanceGroupManagers.applyUpdatesToInstances * @memberOf! () * @@ -29200,7 +29259,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.createInstances - * @desc Creates instances with per-instance configs in this managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method. (== suppress_warning http-rest-shadowed ==) + * @desc Creates instances with per-instance configs in this managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method. * @alias compute.instanceGroupManagers.createInstances * @memberOf! () * @@ -29278,7 +29337,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.delete - * @desc Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information. * @alias compute.instanceGroupManagers.delete * @memberOf! () * @@ -29355,7 +29414,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.deleteInstances - * @desc Flags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. (== suppress_warning http-rest-shadowed ==) + * @desc Flags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @alias compute.instanceGroupManagers.deleteInstances * @memberOf! () * @@ -29433,7 +29492,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.deletePerInstanceConfigs - * @desc Deletes selected per-instance configs for the managed instance group. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes selected per-instance configs for the managed instance group. * @alias compute.instanceGroupManagers.deletePerInstanceConfigs * @memberOf! () * @@ -29512,7 +29571,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.get - * @desc Returns all of the details about the specified managed instance group. Gets a list of available managed instance groups by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns all of the details about the specified managed instance group. Gets a list of available managed instance groups by making a list() request. * @alias compute.instanceGroupManagers.get * @memberOf! () * @@ -29590,7 +29649,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.insert - * @desc Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit. * @alias compute.instanceGroupManagers.insert * @memberOf! () * @@ -29667,7 +29726,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.list - * @desc Retrieves a list of managed instance groups that are contained within the specified project and zone. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of managed instance groups that are contained within the specified project and zone. * @alias compute.instanceGroupManagers.list * @memberOf! () * @@ -29748,7 +29807,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.listErrors - * @desc Lists all errors thrown by actions on instances for a given managed instance group. (== suppress_warning http-rest-shadowed ==) + * @desc Lists all errors thrown by actions on instances for a given managed instance group. * @alias compute.instanceGroupManagers.listErrors * @memberOf! () * @@ -29845,7 +29904,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.listManagedInstances - * @desc Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. (== suppress_warning http-rest-shadowed ==) + * @desc Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. * @alias compute.instanceGroupManagers.listManagedInstances * @memberOf! () * @@ -29949,7 +30008,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.listPerInstanceConfigs - * @desc Lists all of the per-instance configs defined for the managed instance group. (== suppress_warning http-rest-shadowed ==) + * @desc Lists all of the per-instance configs defined for the managed instance group. * @alias compute.instanceGroupManagers.listPerInstanceConfigs * @memberOf! () * @@ -30053,7 +30112,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.patch - * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.instanceGroupManagers.patch * @memberOf! () * @@ -30131,7 +30190,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.patchPerInstanceConfigs - * @desc Insert or patch (for the ones that already exist) per-instance configs for the managed instance group. perInstanceConfig.instance serves as a key used to distinguish whether to perform insert or patch. (== suppress_warning http-rest-shadowed ==) + * @desc Insert or patch (for the ones that already exist) per-instance configs for the managed instance group. perInstanceConfig.instance serves as a key used to distinguish whether to perform insert or patch. * @alias compute.instanceGroupManagers.patchPerInstanceConfigs * @memberOf! () * @@ -30211,7 +30270,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.recreateInstances - * @desc Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. (== suppress_warning http-rest-shadowed ==) + * @desc Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @alias compute.instanceGroupManagers.recreateInstances * @memberOf! () * @@ -30289,7 +30348,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.resize - * @desc Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including: + The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. (== suppress_warning http-rest-shadowed ==) + * @desc Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including: + The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. * @alias compute.instanceGroupManagers.resize * @memberOf! () * @@ -30367,7 +30426,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.resizeAdvanced - * @desc Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method. If you increase the size of the instance group, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating, creatingWithoutRetries, or deleting actions with the get or listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. (== suppress_warning http-rest-shadowed ==) + * @desc Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method. If you increase the size of the instance group, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating, creatingWithoutRetries, or deleting actions with the get or listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. * @alias compute.instanceGroupManagers.resizeAdvanced * @memberOf! () * @@ -30445,7 +30504,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.setAutoHealingPolicies - * @desc Modifies the autohealing policies. [Deprecated] This method is deprecated. Please use Patch instead. (== suppress_warning http-rest-shadowed ==) + * @desc Modifies the autohealing policies. [Deprecated] This method is deprecated. Please use Patch instead. * @alias compute.instanceGroupManagers.setAutoHealingPolicies * @memberOf! () * @@ -30525,7 +30584,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.setInstanceTemplate - * @desc Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them. (== suppress_warning http-rest-shadowed ==) + * @desc Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them. * @alias compute.instanceGroupManagers.setInstanceTemplate * @memberOf! () * @@ -30603,7 +30662,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.setTargetPools - * @desc Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group. (== suppress_warning http-rest-shadowed ==) + * @desc Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group. * @alias compute.instanceGroupManagers.setTargetPools * @memberOf! () * @@ -30681,7 +30740,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.instanceGroupManagers.testIamPermissions * @memberOf! () * @@ -30762,7 +30821,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.update - * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listManagedInstances method. (== suppress_warning http-rest-shadowed ==) + * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listManagedInstances method. * @alias compute.instanceGroupManagers.update * @memberOf! () * @@ -30840,7 +30899,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.updatePerInstanceConfigs - * @desc Insert or update (for the ones that already exist) per-instance configs for the managed instance group. perInstanceConfig.instance serves as a key used to distinguish whether to perform insert or patch. (== suppress_warning http-rest-shadowed ==) + * @desc Insert or update (for the ones that already exist) per-instance configs for the managed instance group. perInstanceConfig.instance serves as a key used to distinguish whether to perform insert or patch. * @alias compute.instanceGroupManagers.updatePerInstanceConfigs * @memberOf! () * @@ -30959,6 +31018,10 @@ export namespace compute_alpha { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ @@ -31616,7 +31679,7 @@ export namespace compute_alpha { /** * compute.instanceGroups.addInstances - * @desc Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information. (== suppress_warning http-rest-shadowed ==) + * @desc Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information. * @alias compute.instanceGroups.addInstances * @memberOf! () * @@ -31694,12 +31757,13 @@ export namespace compute_alpha { /** * compute.instanceGroups.aggregatedList - * @desc Retrieves the list of instance groups and sorts them by zone. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of instance groups and sorts them by zone. * @alias compute.instanceGroups.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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. @@ -31779,7 +31843,7 @@ export namespace compute_alpha { /** * compute.instanceGroups.delete - * @desc Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information. * @alias compute.instanceGroups.delete * @memberOf! () * @@ -31856,7 +31920,7 @@ export namespace compute_alpha { /** * compute.instanceGroups.get - * @desc Returns the specified instance group. Gets a list of available instance groups by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified instance group. Gets a list of available instance groups by making a list() request. * @alias compute.instanceGroups.get * @memberOf! () * @@ -31932,7 +31996,7 @@ export namespace compute_alpha { /** * compute.instanceGroups.insert - * @desc Creates an instance group in the specified project using the parameters that are included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates an instance group in the specified project using the parameters that are included in the request. * @alias compute.instanceGroups.insert * @memberOf! () * @@ -32009,7 +32073,7 @@ export namespace compute_alpha { /** * compute.instanceGroups.list - * @desc Retrieves the list of instance groups that are located in the specified project and zone. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of instance groups that are located in the specified project and zone. * @alias compute.instanceGroups.list * @memberOf! () * @@ -32088,7 +32152,7 @@ export namespace compute_alpha { /** * compute.instanceGroups.listInstances - * @desc Lists the instances in the specified instance group. (== suppress_warning http-rest-shadowed ==) + * @desc Lists the instances in the specified instance group. * @alias compute.instanceGroups.listInstances * @memberOf! () * @@ -32176,7 +32240,7 @@ export namespace compute_alpha { /** * compute.instanceGroups.removeInstances - * @desc Removes one or more instances from the specified instance group, but does not delete those instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted. (== suppress_warning http-rest-shadowed ==) + * @desc Removes one or more instances from the specified instance group, but does not delete those instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted. * @alias compute.instanceGroups.removeInstances * @memberOf! () * @@ -32254,7 +32318,7 @@ export namespace compute_alpha { /** * compute.instanceGroups.setNamedPorts - * @desc Sets the named ports for the specified instance group. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the named ports for the specified instance group. * @alias compute.instanceGroups.setNamedPorts * @memberOf! () * @@ -32332,7 +32396,7 @@ export namespace compute_alpha { /** * compute.instanceGroups.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.instanceGroups.testIamPermissions * @memberOf! () * @@ -32452,6 +32516,10 @@ export namespace compute_alpha { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ @@ -32703,7 +32771,7 @@ export namespace compute_alpha { /** * compute.instances.addAccessConfig - * @desc Adds an access config to an instance's network interface. (== suppress_warning http-rest-shadowed ==) + * @desc Adds an access config to an instance's network interface. * @alias compute.instances.addAccessConfig * @memberOf! () * @@ -32782,7 +32850,7 @@ export namespace compute_alpha { /** * compute.instances.addResourcePolicies - * @desc Adds existing resource policies to an instance. You can only add one policy right now which will be applied to this instance for scheduling live migrations. (== suppress_warning http-rest-shadowed ==) + * @desc Adds existing resource policies to an instance. You can only add one policy right now which will be applied to this instance for scheduling live migrations. * @alias compute.instances.addResourcePolicies * @memberOf! () * @@ -32860,12 +32928,13 @@ export namespace compute_alpha { /** * compute.instances.aggregatedList - * @desc Retrieves aggregated list of all of the instances in your project across all regions and zones. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves aggregated list of all of the instances in your project across all regions and zones. * @alias compute.instances.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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. @@ -32941,7 +33010,7 @@ export namespace compute_alpha { /** * compute.instances.attachDisk - * @desc Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance. (== suppress_warning http-rest-shadowed ==) + * @desc Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance. * @alias compute.instances.attachDisk * @memberOf! () * @@ -33020,7 +33089,7 @@ export namespace compute_alpha { /** * compute.instances.delete - * @desc Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance. * @alias compute.instances.delete * @memberOf! () * @@ -33096,7 +33165,7 @@ export namespace compute_alpha { /** * compute.instances.deleteAccessConfig - * @desc Deletes an access config from an instance's network interface. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes an access config from an instance's network interface. * @alias compute.instances.deleteAccessConfig * @memberOf! () * @@ -33181,7 +33250,7 @@ export namespace compute_alpha { /** * compute.instances.detachDisk - * @desc Detaches a disk from an instance. (== suppress_warning http-rest-shadowed ==) + * @desc Detaches a disk from an instance. * @alias compute.instances.detachDisk * @memberOf! () * @@ -33259,7 +33328,7 @@ export namespace compute_alpha { /** * compute.instances.get - * @desc Returns the specified Instance resource. Gets a list of available instances by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified Instance resource. Gets a list of available instances by making a list() request. * @alias compute.instances.get * @memberOf! () * @@ -33332,7 +33401,7 @@ export namespace compute_alpha { /** * compute.instances.getEffectiveFirewalls - * @desc Returns effective firewalls applied to an interface of the instance. (== suppress_warning http-rest-shadowed ==) + * @desc Returns effective firewalls applied to an interface of the instance. * @alias compute.instances.getEffectiveFirewalls * @memberOf! () * @@ -33426,7 +33495,7 @@ export namespace compute_alpha { /** * compute.instances.getGuestAttributes - * @desc Returns the specified guest attributes entry. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified guest attributes entry. * @alias compute.instances.getGuestAttributes * @memberOf! () * @@ -33506,7 +33575,7 @@ export namespace compute_alpha { /** * compute.instances.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.instances.getIamPolicy * @memberOf! () * @@ -33581,7 +33650,7 @@ export namespace compute_alpha { /** * compute.instances.getSerialPortOutput - * @desc Returns the last 1 MB of serial port output from the specified instance. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the last 1 MB of serial port output from the specified instance. * @alias compute.instances.getSerialPortOutput * @memberOf! () * @@ -33661,7 +33730,7 @@ export namespace compute_alpha { /** * compute.instances.getShieldedInstanceIdentity - * @desc Returns the Shielded Instance Identity of an instance (== suppress_warning http-rest-shadowed ==) + * @desc Returns the Shielded Instance Identity of an instance * @alias compute.instances.getShieldedInstanceIdentity * @memberOf! () * @@ -33741,7 +33810,7 @@ export namespace compute_alpha { /** * compute.instances.getShieldedVmIdentity - * @desc Returns the Shielded VM Identity of an instance (== suppress_warning http-rest-shadowed ==) + * @desc Returns the Shielded VM Identity of an instance * @alias compute.instances.getShieldedVmIdentity * @memberOf! () * @@ -33819,7 +33888,7 @@ export namespace compute_alpha { /** * compute.instances.insert - * @desc Creates an instance resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates an instance resource in the specified project using the data included in the request. * @alias compute.instances.insert * @memberOf! () * @@ -33897,7 +33966,7 @@ export namespace compute_alpha { /** * compute.instances.list - * @desc Retrieves the list of instances contained within the specified zone. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of instances contained within the specified zone. * @alias compute.instances.list * @memberOf! () * @@ -33975,7 +34044,7 @@ export namespace compute_alpha { /** * compute.instances.listReferrers - * @desc Retrieves the list of referrers to instances contained within the specified zone. For more information, read Viewing Referrers to VM Instances. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of referrers to instances contained within the specified zone. For more information, read Viewing Referrers to VM Instances. * @alias compute.instances.listReferrers * @memberOf! () * @@ -34059,7 +34128,7 @@ export namespace compute_alpha { /** * compute.instances.removeResourcePolicies - * @desc Removes resource policies from an instance. (== suppress_warning http-rest-shadowed ==) + * @desc Removes resource policies from an instance. * @alias compute.instances.removeResourcePolicies * @memberOf! () * @@ -34139,7 +34208,7 @@ export namespace compute_alpha { /** * compute.instances.reset - * @desc Performs a reset on the instance. This is a hard reset the VM does not do a graceful shutdown. For more information, see Resetting an instance. (== suppress_warning http-rest-shadowed ==) + * @desc Performs a reset on the instance. This is a hard reset the VM does not do a graceful shutdown. For more information, see Resetting an instance. * @alias compute.instances.reset * @memberOf! () * @@ -34215,7 +34284,7 @@ export namespace compute_alpha { /** * compute.instances.resume - * @desc Resumes an instance that was suspended using the instances().suspend method. (== suppress_warning http-rest-shadowed ==) + * @desc Resumes an instance that was suspended using the instances().suspend method. * @alias compute.instances.resume * @memberOf! () * @@ -34292,7 +34361,7 @@ export namespace compute_alpha { /** * compute.instances.setDeletionProtection - * @desc Sets deletion protection on the instance. (== suppress_warning http-rest-shadowed ==) + * @desc Sets deletion protection on the instance. * @alias compute.instances.setDeletionProtection * @memberOf! () * @@ -34372,7 +34441,7 @@ export namespace compute_alpha { /** * compute.instances.setDiskAutoDelete - * @desc Sets the auto-delete flag for a disk attached to an instance. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the auto-delete flag for a disk attached to an instance. * @alias compute.instances.setDiskAutoDelete * @memberOf! () * @@ -34457,7 +34526,7 @@ export namespace compute_alpha { /** * compute.instances.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.instances.setIamPolicy * @memberOf! () * @@ -34532,7 +34601,7 @@ export namespace compute_alpha { /** * compute.instances.setLabels - * @desc Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) + * @desc Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation. * @alias compute.instances.setLabels * @memberOf! () * @@ -34610,7 +34679,7 @@ export namespace compute_alpha { /** * compute.instances.setMachineResources - * @desc Changes the number and/or type of accelerator for a stopped instance to the values specified in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Changes the number and/or type of accelerator for a stopped instance to the values specified in the request. * @alias compute.instances.setMachineResources * @memberOf! () * @@ -34688,7 +34757,7 @@ export namespace compute_alpha { /** * compute.instances.setMachineType - * @desc Changes the machine type for a stopped instance to the machine type specified in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Changes the machine type for a stopped instance to the machine type specified in the request. * @alias compute.instances.setMachineType * @memberOf! () * @@ -34766,7 +34835,7 @@ export namespace compute_alpha { /** * compute.instances.setMetadata - * @desc Sets metadata for the specified instance to the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Sets metadata for the specified instance to the data included in the request. * @alias compute.instances.setMetadata * @memberOf! () * @@ -34844,7 +34913,7 @@ export namespace compute_alpha { /** * compute.instances.setMinCpuPlatform - * @desc Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform. (== suppress_warning http-rest-shadowed ==) + * @desc Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform. * @alias compute.instances.setMinCpuPlatform * @memberOf! () * @@ -34922,7 +34991,7 @@ export namespace compute_alpha { /** * compute.instances.setName - * @desc Sets name of an instance. (== suppress_warning http-rest-shadowed ==) + * @desc Sets name of an instance. * @alias compute.instances.setName * @memberOf! () * @@ -35000,7 +35069,7 @@ export namespace compute_alpha { /** * compute.instances.setScheduling - * @desc Sets an instance's scheduling options. (== suppress_warning http-rest-shadowed ==) + * @desc Sets an instance's scheduling options. * @alias compute.instances.setScheduling * @memberOf! () * @@ -35078,7 +35147,7 @@ export namespace compute_alpha { /** * compute.instances.setServiceAccount - * @desc Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance. * @alias compute.instances.setServiceAccount * @memberOf! () * @@ -35156,7 +35225,7 @@ export namespace compute_alpha { /** * compute.instances.setShieldedInstanceIntegrityPolicy - * @desc Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.instances.setShieldedInstanceIntegrityPolicy * @memberOf! () * @@ -35236,7 +35305,7 @@ export namespace compute_alpha { /** * compute.instances.setShieldedVmIntegrityPolicy - * @desc Sets the Shielded VM integrity policy for a VM instance. You can only use this method on a running VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the Shielded VM integrity policy for a VM instance. You can only use this method on a running VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.instances.setShieldedVmIntegrityPolicy * @memberOf! () * @@ -35316,7 +35385,7 @@ export namespace compute_alpha { /** * compute.instances.setTags - * @desc Sets network tags for the specified instance to the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Sets network tags for the specified instance to the data included in the request. * @alias compute.instances.setTags * @memberOf! () * @@ -35394,7 +35463,7 @@ export namespace compute_alpha { /** * compute.instances.simulateMaintenanceEvent - * @desc Simulates a maintenance event on the instance. (== suppress_warning http-rest-shadowed ==) + * @desc Simulates a maintenance event on the instance. * @alias compute.instances.simulateMaintenanceEvent * @memberOf! () * @@ -35472,7 +35541,7 @@ export namespace compute_alpha { /** * compute.instances.start - * @desc Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. (== suppress_warning http-rest-shadowed ==) + * @desc Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. * @alias compute.instances.start * @memberOf! () * @@ -35548,7 +35617,7 @@ export namespace compute_alpha { /** * compute.instances.startWithEncryptionKey - * @desc Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. (== suppress_warning http-rest-shadowed ==) + * @desc Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. * @alias compute.instances.startWithEncryptionKey * @memberOf! () * @@ -35628,7 +35697,7 @@ export namespace compute_alpha { /** * compute.instances.stop - * @desc Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance. (== suppress_warning http-rest-shadowed ==) + * @desc Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance. * @alias compute.instances.stop * @memberOf! () * @@ -35705,7 +35774,7 @@ export namespace compute_alpha { /** * compute.instances.suspend - * @desc This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances incur reduced per-minute, virtual machine usage charges while they are suspended. Any resources the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. (== suppress_warning http-rest-shadowed ==) + * @desc This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances incur reduced per-minute, virtual machine usage charges while they are suspended. Any resources the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. * @alias compute.instances.suspend * @memberOf! () * @@ -35783,7 +35852,7 @@ export namespace compute_alpha { /** * compute.instances.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.instances.testIamPermissions * @memberOf! () * @@ -35862,9 +35931,88 @@ export namespace compute_alpha { } } + /** + * compute.instances.update + * @desc Updates an instance. + * @alias compute.instances.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Name of the instance resource to update. + * @param {string=} params.minimalAction If specified, this action or higher level action is performed on the instance irrespective of what action is required for the update to take effect. If not specified, then Compute Engine acts based on the minimum action required. + * @param {string=} params.mostDisruptiveAllowedAction If specified, Compute Engine returns an error if the update requires a higher action to be applied to the instance. If not specified, the default will be REFRESH. + * @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 {().Instance} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Instances$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Instances$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Instances$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Instances$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Instances$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * compute.instances.updateAccessConfig - * @desc Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.instances.updateAccessConfig * @memberOf! () * @@ -35943,7 +36091,7 @@ export namespace compute_alpha { /** * compute.instances.updateDisplayDevice - * @desc Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.instances.updateDisplayDevice * @memberOf! () * @@ -36021,7 +36169,7 @@ export namespace compute_alpha { /** * compute.instances.updateNetworkInterface - * @desc Updates an instance's network interface. This method follows PATCH semantics. (== suppress_warning http-rest-shadowed ==) + * @desc Updates an instance's network interface. This method follows PATCH semantics. * @alias compute.instances.updateNetworkInterface * @memberOf! () * @@ -36102,7 +36250,7 @@ export namespace compute_alpha { /** * compute.instances.updateShieldedInstanceConfig - * @desc Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.instances.updateShieldedInstanceConfig * @memberOf! () * @@ -36182,7 +36330,7 @@ export namespace compute_alpha { /** * compute.instances.updateShieldedVmConfig - * @desc Updates the Shielded VM config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the Shielded VM config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.instances.updateShieldedVmConfig * @memberOf! () * @@ -36334,6 +36482,10 @@ export namespace compute_alpha { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ @@ -37365,6 +37517,42 @@ export namespace compute_alpha { */ requestBody?: Schema$TestPermissionsRequest; } + export interface Params$Resource$Instances$Update extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the instance resource to update. + */ + instance?: string; + /** + * If specified, this action or higher level action is performed on the instance irrespective of what action is required for the update to take effect. If not specified, then Compute Engine acts based on the minimum action required. + */ + minimalAction?: string; + /** + * If specified, Compute Engine returns an error if the update requires a higher action to be applied to the instance. If not specified, the default will be REFRESH. + */ + mostDisruptiveAllowedAction?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Instance; + } export interface Params$Resource$Instances$Updateaccessconfig extends StandardParameters { /** @@ -37527,7 +37715,7 @@ export namespace compute_alpha { /** * compute.instanceTemplates.delete - * @desc Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are already in use by a managed instance group. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are already in use by a managed instance group. * @alias compute.instanceTemplates.delete * @memberOf! () * @@ -37603,7 +37791,7 @@ export namespace compute_alpha { /** * compute.instanceTemplates.get - * @desc Returns the specified instance template. Gets a list of available instance templates by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified instance template. Gets a list of available instance templates by making a list() request. * @alias compute.instanceTemplates.get * @memberOf! () * @@ -37678,7 +37866,7 @@ export namespace compute_alpha { /** * compute.instanceTemplates.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.instanceTemplates.getIamPolicy * @memberOf! () * @@ -37752,7 +37940,7 @@ export namespace compute_alpha { /** * compute.instanceTemplates.insert - * @desc Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template. (== suppress_warning http-rest-shadowed ==) + * @desc Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template. * @alias compute.instanceTemplates.insert * @memberOf! () * @@ -37828,7 +38016,7 @@ export namespace compute_alpha { /** * compute.instanceTemplates.list - * @desc Retrieves a list of instance templates that are contained within the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of instance templates that are contained within the specified project. * @alias compute.instanceTemplates.list * @memberOf! () * @@ -37908,7 +38096,7 @@ export namespace compute_alpha { /** * compute.instanceTemplates.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.instanceTemplates.setIamPolicy * @memberOf! () * @@ -37982,7 +38170,7 @@ export namespace compute_alpha { /** * compute.instanceTemplates.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.instanceTemplates.testIamPermissions * @memberOf! () * @@ -38217,12 +38405,13 @@ export namespace compute_alpha { /** * compute.interconnectAttachments.aggregatedList - * @desc Retrieves an aggregated list of interconnect attachments. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of interconnect attachments. * @alias compute.interconnectAttachments.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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. @@ -38312,7 +38501,7 @@ export namespace compute_alpha { /** * compute.interconnectAttachments.delete - * @desc Deletes the specified interconnect attachment. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified interconnect attachment. * @alias compute.interconnectAttachments.delete * @memberOf! () * @@ -38389,7 +38578,7 @@ export namespace compute_alpha { /** * compute.interconnectAttachments.get - * @desc Returns the specified interconnect attachment. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified interconnect attachment. * @alias compute.interconnectAttachments.get * @memberOf! () * @@ -38467,7 +38656,7 @@ export namespace compute_alpha { /** * compute.interconnectAttachments.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.interconnectAttachments.getIamPolicy * @memberOf! () * @@ -38542,7 +38731,7 @@ export namespace compute_alpha { /** * compute.interconnectAttachments.insert - * @desc Creates an InterconnectAttachment in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates an InterconnectAttachment in the specified project using the data included in the request. * @alias compute.interconnectAttachments.insert * @memberOf! () * @@ -38620,7 +38809,7 @@ export namespace compute_alpha { /** * compute.interconnectAttachments.list - * @desc Retrieves the list of interconnect attachments contained within the specified region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of interconnect attachments contained within the specified region. * @alias compute.interconnectAttachments.list * @memberOf! () * @@ -38706,7 +38895,7 @@ export namespace compute_alpha { /** * compute.interconnectAttachments.patch - * @desc Updates the specified interconnect attachment with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified interconnect attachment with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.interconnectAttachments.patch * @memberOf! () * @@ -38784,7 +38973,7 @@ export namespace compute_alpha { /** * compute.interconnectAttachments.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.interconnectAttachments.setIamPolicy * @memberOf! () * @@ -38859,7 +39048,7 @@ export namespace compute_alpha { /** * compute.interconnectAttachments.setLabels - * @desc Sets the labels on an InterconnectAttachment. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the labels on an InterconnectAttachment. To learn more about labels, read the Labeling Resources documentation. * @alias compute.interconnectAttachments.setLabels * @memberOf! () * @@ -38937,7 +39126,7 @@ export namespace compute_alpha { /** * compute.interconnectAttachments.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.interconnectAttachments.testIamPermissions * @memberOf! () * @@ -39028,6 +39217,10 @@ export namespace compute_alpha { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ @@ -39291,7 +39484,7 @@ export namespace compute_alpha { /** * compute.interconnectLocations.get - * @desc Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request. * @alias compute.interconnectLocations.get * @memberOf! () * @@ -39368,7 +39561,7 @@ export namespace compute_alpha { /** * compute.interconnectLocations.list - * @desc Retrieves the list of interconnect locations available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of interconnect locations available to the specified project. * @alias compute.interconnectLocations.list * @memberOf! () * @@ -39448,7 +39641,7 @@ export namespace compute_alpha { /** * compute.interconnectLocations.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.interconnectLocations.testIamPermissions * @memberOf! () * @@ -39601,7 +39794,7 @@ export namespace compute_alpha { /** * compute.interconnects.delete - * @desc Deletes the specified interconnect. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified interconnect. * @alias compute.interconnects.delete * @memberOf! () * @@ -39677,7 +39870,7 @@ export namespace compute_alpha { /** * compute.interconnects.get - * @desc Returns the specified interconnect. Get a list of available interconnects by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified interconnect. Get a list of available interconnects by making a list() request. * @alias compute.interconnects.get * @memberOf! () * @@ -39752,7 +39945,7 @@ export namespace compute_alpha { /** * compute.interconnects.getDiagnostics - * @desc Returns the interconnectDiagnostics for the specified interconnect. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the interconnectDiagnostics for the specified interconnect. * @alias compute.interconnects.getDiagnostics * @memberOf! () * @@ -39838,7 +40031,7 @@ export namespace compute_alpha { /** * compute.interconnects.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.interconnects.getIamPolicy * @memberOf! () * @@ -39912,7 +40105,7 @@ export namespace compute_alpha { /** * compute.interconnects.insert - * @desc Creates a Interconnect in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a Interconnect in the specified project using the data included in the request. * @alias compute.interconnects.insert * @memberOf! () * @@ -39987,7 +40180,7 @@ export namespace compute_alpha { /** * compute.interconnects.list - * @desc Retrieves the list of interconnect available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of interconnect available to the specified project. * @alias compute.interconnects.list * @memberOf! () * @@ -40064,7 +40257,7 @@ export namespace compute_alpha { /** * compute.interconnects.patch - * @desc Updates the specified interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.interconnects.patch * @memberOf! () * @@ -40141,7 +40334,7 @@ export namespace compute_alpha { /** * compute.interconnects.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.interconnects.setIamPolicy * @memberOf! () * @@ -40215,7 +40408,7 @@ export namespace compute_alpha { /** * compute.interconnects.setLabels - * @desc Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation. * @alias compute.interconnects.setLabels * @memberOf! () * @@ -40291,7 +40484,7 @@ export namespace compute_alpha { /** * compute.interconnects.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.interconnects.testIamPermissions * @memberOf! () * @@ -40588,7 +40781,7 @@ export namespace compute_alpha { /** * compute.licenseCodes.get - * @desc Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code. (== suppress_warning http-rest-shadowed ==) + * @desc Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code. * @alias compute.licenseCodes.get * @memberOf! () * @@ -40662,7 +40855,7 @@ export namespace compute_alpha { /** * compute.licenseCodes.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.licenseCodes.getIamPolicy * @memberOf! () * @@ -40736,7 +40929,7 @@ export namespace compute_alpha { /** * compute.licenseCodes.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.licenseCodes.setIamPolicy * @memberOf! () * @@ -40810,7 +41003,7 @@ export namespace compute_alpha { /** * compute.licenseCodes.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.licenseCodes.testIamPermissions * @memberOf! () * @@ -40975,7 +41168,7 @@ export namespace compute_alpha { /** * compute.licenses.delete - * @desc Deletes the specified license. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified license. * @alias compute.licenses.delete * @memberOf! () * @@ -41050,7 +41243,7 @@ export namespace compute_alpha { /** * compute.licenses.get - * @desc Returns the specified License resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified License resource. * @alias compute.licenses.get * @memberOf! () * @@ -41122,7 +41315,7 @@ export namespace compute_alpha { /** * compute.licenses.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.licenses.getIamPolicy * @memberOf! () * @@ -41196,7 +41389,7 @@ export namespace compute_alpha { /** * compute.licenses.insert - * @desc Create a License resource in the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Create a License resource in the specified project. * @alias compute.licenses.insert * @memberOf! () * @@ -41270,7 +41463,7 @@ export namespace compute_alpha { /** * compute.licenses.list - * @desc Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. * @alias compute.licenses.list * @memberOf! () * @@ -41348,7 +41541,7 @@ export namespace compute_alpha { /** * compute.licenses.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.licenses.setIamPolicy * @memberOf! () * @@ -41422,7 +41615,7 @@ export namespace compute_alpha { /** * compute.licenses.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.licenses.testIamPermissions * @memberOf! () * @@ -41653,7 +41846,7 @@ export namespace compute_alpha { /** * compute.machineImages.delete - * @desc Deletes the specified machine image. Deleting a machine image is permanent and cannot be undone. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified machine image. Deleting a machine image is permanent and cannot be undone. * @alias compute.machineImages.delete * @memberOf! () * @@ -41729,7 +41922,7 @@ export namespace compute_alpha { /** * compute.machineImages.get - * @desc Returns the specified machine image. Gets a list of available machine images by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified machine image. Gets a list of available machine images by making a list() request. * @alias compute.machineImages.get * @memberOf! () * @@ -41804,7 +41997,7 @@ export namespace compute_alpha { /** * compute.machineImages.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.machineImages.getIamPolicy * @memberOf! () * @@ -41878,7 +42071,7 @@ export namespace compute_alpha { /** * compute.machineImages.insert - * @desc Creates a machine image in the specified project using the data that is included in the request. If you are creating a new machine image to update an existing instance, your new machine image should use the same network or, if applicable, the same subnetwork as the original instance. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a machine image in the specified project using the data that is included in the request. If you are creating a new machine image to update an existing instance, your new machine image should use the same network or, if applicable, the same subnetwork as the original instance. * @alias compute.machineImages.insert * @memberOf! () * @@ -41954,7 +42147,7 @@ export namespace compute_alpha { /** * compute.machineImages.list - * @desc Retrieves a list of machine images that are contained within the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of machine images that are contained within the specified project. * @alias compute.machineImages.list * @memberOf! () * @@ -42031,7 +42224,7 @@ export namespace compute_alpha { /** * compute.machineImages.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.machineImages.setIamPolicy * @memberOf! () * @@ -42105,7 +42298,7 @@ export namespace compute_alpha { /** * compute.machineImages.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.machineImages.testIamPermissions * @memberOf! () * @@ -42344,12 +42537,13 @@ export namespace compute_alpha { /** * compute.machineTypes.aggregatedList - * @desc Retrieves an aggregated list of machine types. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of machine types. * @alias compute.machineTypes.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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. @@ -42429,7 +42623,7 @@ export namespace compute_alpha { /** * compute.machineTypes.get - * @desc Returns the specified machine type. Gets a list of available machine types by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified machine type. Gets a list of available machine types by making a list() request. * @alias compute.machineTypes.get * @memberOf! () * @@ -42504,7 +42698,7 @@ export namespace compute_alpha { /** * compute.machineTypes.list - * @desc Retrieves a list of machine types available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of machine types available to the specified project. * @alias compute.machineTypes.list * @memberOf! () * @@ -42593,6 +42787,10 @@ export namespace compute_alpha { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ @@ -42670,12 +42868,13 @@ export namespace compute_alpha { /** * compute.networkEndpointGroups.aggregatedList - * @desc Retrieves the list of network endpoint groups and sorts them by zone. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of network endpoint groups and sorts them by zone. * @alias compute.networkEndpointGroups.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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. @@ -42757,7 +42956,7 @@ export namespace compute_alpha { /** * compute.networkEndpointGroups.attachNetworkEndpoints - * @desc Attach a list of network endpoints to the specified network endpoint group. (== suppress_warning http-rest-shadowed ==) + * @desc Attach a list of network endpoints to the specified network endpoint group. * @alias compute.networkEndpointGroups.attachNetworkEndpoints * @memberOf! () * @@ -42837,7 +43036,7 @@ export namespace compute_alpha { /** * compute.networkEndpointGroups.delete - * @desc Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it. (== suppress_warning http-rest-shadowed ==) + * @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! () * @@ -42914,7 +43113,7 @@ export namespace compute_alpha { /** * compute.networkEndpointGroups.detachNetworkEndpoints - * @desc Detach a list of network endpoints from the specified network endpoint group. (== suppress_warning http-rest-shadowed ==) + * @desc Detach a list of network endpoints from the specified network endpoint group. * @alias compute.networkEndpointGroups.detachNetworkEndpoints * @memberOf! () * @@ -42994,7 +43193,7 @@ export namespace compute_alpha { /** * compute.networkEndpointGroups.get - * @desc Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request. * @alias compute.networkEndpointGroups.get * @memberOf! () * @@ -43072,7 +43271,7 @@ export namespace compute_alpha { /** * compute.networkEndpointGroups.insert - * @desc Creates a network endpoint group in the specified project using the parameters that are included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a network endpoint group in the specified project using the parameters that are included in the request. * @alias compute.networkEndpointGroups.insert * @memberOf! () * @@ -43149,7 +43348,7 @@ export namespace compute_alpha { /** * compute.networkEndpointGroups.list - * @desc Retrieves the list of network endpoint groups that are located in the specified project and zone. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of network endpoint groups that are located in the specified project and zone. * @alias compute.networkEndpointGroups.list * @memberOf! () * @@ -43230,7 +43429,7 @@ export namespace compute_alpha { /** * compute.networkEndpointGroups.listNetworkEndpoints - * @desc Lists the network endpoints in the specified network endpoint group. (== suppress_warning http-rest-shadowed ==) + * @desc Lists the network endpoints in the specified network endpoint group. * @alias compute.networkEndpointGroups.listNetworkEndpoints * @memberOf! () * @@ -43334,7 +43533,7 @@ export namespace compute_alpha { /** * compute.networkEndpointGroups.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.networkEndpointGroups.testIamPermissions * @memberOf! () * @@ -43425,6 +43624,10 @@ export namespace compute_alpha { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ @@ -43676,7 +43879,7 @@ export namespace compute_alpha { /** * compute.networks.addPeering - * @desc Adds a peering to the specified network. (== suppress_warning http-rest-shadowed ==) + * @desc Adds a peering to the specified network. * @alias compute.networks.addPeering * @memberOf! () * @@ -43753,7 +43956,7 @@ export namespace compute_alpha { /** * compute.networks.delete - * @desc Deletes the specified network. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified network. * @alias compute.networks.delete * @memberOf! () * @@ -43828,7 +44031,7 @@ export namespace compute_alpha { /** * compute.networks.get - * @desc Returns the specified network. Gets a list of available networks by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified network. Gets a list of available networks by making a list() request. * @alias compute.networks.get * @memberOf! () * @@ -43900,7 +44103,7 @@ export namespace compute_alpha { /** * compute.networks.getEffectiveFirewalls - * @desc Returns the effective firewalls on a given network. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the effective firewalls on a given network. * @alias compute.networks.getEffectiveFirewalls * @memberOf! () * @@ -43992,7 +44195,7 @@ export namespace compute_alpha { /** * compute.networks.insert - * @desc Creates a network in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a network in the specified project using the data included in the request. * @alias compute.networks.insert * @memberOf! () * @@ -44066,7 +44269,7 @@ export namespace compute_alpha { /** * compute.networks.list - * @desc Retrieves the list of networks available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of networks available to the specified project. * @alias compute.networks.list * @memberOf! () * @@ -44142,7 +44345,7 @@ export namespace compute_alpha { /** * compute.networks.listIpAddresses - * @desc Lists the internal IP addresses in the specified network. (== suppress_warning http-rest-shadowed ==) + * @desc Lists the internal IP addresses in the specified network. * @alias compute.networks.listIpAddresses * @memberOf! () * @@ -44224,7 +44427,7 @@ export namespace compute_alpha { /** * compute.networks.listIpOwners - * @desc Lists the internal IP owners in the specified network. (== suppress_warning http-rest-shadowed ==) + * @desc Lists the internal IP owners in the specified network. * @alias compute.networks.listIpOwners * @memberOf! () * @@ -44308,7 +44511,7 @@ export namespace compute_alpha { /** * compute.networks.listPeeringRoutes - * @desc Lists the peering routes exchanged over peering connection. (== suppress_warning http-rest-shadowed ==) + * @desc Lists the peering routes exchanged over peering connection. * @alias compute.networks.listPeeringRoutes * @memberOf! () * @@ -44397,7 +44600,7 @@ export namespace compute_alpha { /** * compute.networks.patch - * @desc Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode. (== suppress_warning http-rest-shadowed ==) + * @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! () * @@ -44473,7 +44676,7 @@ export namespace compute_alpha { /** * compute.networks.removePeering - * @desc Removes a peering from the specified network. (== suppress_warning http-rest-shadowed ==) + * @desc Removes a peering from the specified network. * @alias compute.networks.removePeering * @memberOf! () * @@ -44550,7 +44753,7 @@ export namespace compute_alpha { /** * compute.networks.switchToCustomMode - * @desc Switches the network mode from auto subnet mode to custom subnet mode. (== suppress_warning http-rest-shadowed ==) + * @desc Switches the network mode from auto subnet mode to custom subnet mode. * @alias compute.networks.switchToCustomMode * @memberOf! () * @@ -44626,7 +44829,7 @@ export namespace compute_alpha { /** * compute.networks.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.networks.testIamPermissions * @memberOf! () * @@ -44706,7 +44909,7 @@ export namespace compute_alpha { /** * compute.networks.updatePeering - * @desc Updates the specified network peering with the data included in the request Only the following fields can be modified: NetworkPeering.export_custom_routes, and NetworkPeering.import_custom_routes (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified network peering with the data included in the request Only the following fields can be modified: NetworkPeering.export_custom_routes, and NetworkPeering.import_custom_routes * @alias compute.networks.updatePeering * @memberOf! () * @@ -45160,7 +45363,7 @@ export namespace compute_alpha { /** * compute.nodeGroups.addNodes - * @desc Adds specified number of nodes to the node group. (== suppress_warning http-rest-shadowed ==) + * @desc Adds specified number of nodes to the node group. * @alias compute.nodeGroups.addNodes * @memberOf! () * @@ -45238,12 +45441,13 @@ export namespace compute_alpha { /** * compute.nodeGroups.aggregatedList - * @desc Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group. * @alias compute.nodeGroups.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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. @@ -45320,7 +45524,7 @@ export namespace compute_alpha { /** * compute.nodeGroups.delete - * @desc Deletes the specified NodeGroup resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified NodeGroup resource. * @alias compute.nodeGroups.delete * @memberOf! () * @@ -45397,7 +45601,7 @@ export namespace compute_alpha { /** * compute.nodeGroups.deleteNodes - * @desc Deletes specified nodes from the node group. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes specified nodes from the node group. * @alias compute.nodeGroups.deleteNodes * @memberOf! () * @@ -45475,7 +45679,7 @@ export namespace compute_alpha { /** * compute.nodeGroups.get - * @desc Returns the specified NodeGroup. Get a list of available NodeGroups by making a list() request. Note: the "nodes" field should not be used. Use nodeGroups.listNodes instead. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified NodeGroup. Get a list of available NodeGroups by making a list() request. Note: the "nodes" field should not be used. Use nodeGroups.listNodes instead. * @alias compute.nodeGroups.get * @memberOf! () * @@ -45550,7 +45754,7 @@ export namespace compute_alpha { /** * compute.nodeGroups.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.nodeGroups.getIamPolicy * @memberOf! () * @@ -45625,7 +45829,7 @@ export namespace compute_alpha { /** * compute.nodeGroups.insert - * @desc Creates a NodeGroup resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a NodeGroup resource in the specified project using the data included in the request. * @alias compute.nodeGroups.insert * @memberOf! () * @@ -45703,7 +45907,7 @@ export namespace compute_alpha { /** * compute.nodeGroups.list - * @desc Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group. * @alias compute.nodeGroups.list * @memberOf! () * @@ -45781,7 +45985,7 @@ export namespace compute_alpha { /** * compute.nodeGroups.listNodes - * @desc Lists nodes in the node group. (== suppress_warning http-rest-shadowed ==) + * @desc Lists nodes in the node group. * @alias compute.nodeGroups.listNodes * @memberOf! () * @@ -45859,9 +46063,86 @@ export namespace compute_alpha { } } + /** + * compute.nodeGroups.patch + * @desc Patch the node group. + * @alias compute.nodeGroups.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.nodeGroup Name of the NodeGroup resource to update. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone for this request. + * @param {().NodeGroup} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Nodegroups$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Nodegroups$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Nodegroups$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Nodegroups$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Nodegroups$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodegroups$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'nodeGroup'], + pathParams: ['nodeGroup', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * compute.nodeGroups.setAutoscalingPolicy - * @desc Sets the autoscaling policy of the node group. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the autoscaling policy of the node group. * @alias compute.nodeGroups.setAutoscalingPolicy * @memberOf! () * @@ -45941,7 +46222,7 @@ export namespace compute_alpha { /** * compute.nodeGroups.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.nodeGroups.setIamPolicy * @memberOf! () * @@ -46016,7 +46297,7 @@ export namespace compute_alpha { /** * compute.nodeGroups.setNodeTemplate - * @desc Updates the node template of the node group. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the node template of the node group. * @alias compute.nodeGroups.setNodeTemplate * @memberOf! () * @@ -46094,7 +46375,7 @@ export namespace compute_alpha { /** * compute.nodeGroups.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.nodeGroups.testIamPermissions * @memberOf! () * @@ -46214,6 +46495,10 @@ export namespace compute_alpha { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ @@ -46423,6 +46708,34 @@ export namespace compute_alpha { */ zone?: string; } + export interface Params$Resource$Nodegroups$Patch extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the NodeGroup resource to update. + */ + nodeGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NodeGroup; + } export interface Params$Resource$Nodegroups$Setautoscalingpolicy extends StandardParameters { /** @@ -46540,12 +46853,13 @@ export namespace compute_alpha { /** * compute.nodeTemplates.aggregatedList - * @desc Retrieves an aggregated list of node templates. (== suppress_warning http-rest-shadowed ==) + * @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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. @@ -46625,7 +46939,7 @@ export namespace compute_alpha { /** * compute.nodeTemplates.delete - * @desc Deletes the specified NodeTemplate resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified NodeTemplate resource. * @alias compute.nodeTemplates.delete * @memberOf! () * @@ -46702,7 +47016,7 @@ export namespace compute_alpha { /** * compute.nodeTemplates.get - * @desc Returns the specified node template. Gets a list of available node templates by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified node template. Gets a list of available node templates by making a list() request. * @alias compute.nodeTemplates.get * @memberOf! () * @@ -46778,7 +47092,7 @@ export namespace compute_alpha { /** * compute.nodeTemplates.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.nodeTemplates.getIamPolicy * @memberOf! () * @@ -46853,7 +47167,7 @@ export namespace compute_alpha { /** * compute.nodeTemplates.insert - * @desc Creates a NodeTemplate resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a NodeTemplate resource in the specified project using the data included in the request. * @alias compute.nodeTemplates.insert * @memberOf! () * @@ -46930,7 +47244,7 @@ export namespace compute_alpha { /** * compute.nodeTemplates.list - * @desc Retrieves a list of node templates available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of node templates available to the specified project. * @alias compute.nodeTemplates.list * @memberOf! () * @@ -47009,7 +47323,7 @@ export namespace compute_alpha { /** * compute.nodeTemplates.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.nodeTemplates.setIamPolicy * @memberOf! () * @@ -47084,7 +47398,7 @@ export namespace compute_alpha { /** * compute.nodeTemplates.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.nodeTemplates.testIamPermissions * @memberOf! () * @@ -47175,6 +47489,10 @@ export namespace compute_alpha { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ @@ -47376,12 +47694,13 @@ export namespace compute_alpha { /** * compute.nodeTypes.aggregatedList - * @desc Retrieves an aggregated list of node types. (== suppress_warning http-rest-shadowed ==) + * @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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. @@ -47457,7 +47776,7 @@ export namespace compute_alpha { /** * compute.nodeTypes.get - * @desc Returns the specified node type. Gets a list of available node types by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified node type. Gets a list of available node types by making a list() request. * @alias compute.nodeTypes.get * @memberOf! () * @@ -47530,7 +47849,7 @@ export namespace compute_alpha { /** * compute.nodeTypes.list - * @desc Retrieves a list of node types available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of node types available to the specified project. * @alias compute.nodeTypes.list * @memberOf! () * @@ -47618,6 +47937,10 @@ export namespace compute_alpha { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ @@ -47694,7 +48017,7 @@ export namespace compute_alpha { /** * compute.organizationSecurityPolicies.addAssociation - * @desc Inserts an association for the specified security policy. (== suppress_warning http-rest-shadowed ==) + * @desc Inserts an association for the specified security policy. * @alias compute.organizationSecurityPolicies.addAssociation * @memberOf! () * @@ -47771,7 +48094,7 @@ export namespace compute_alpha { /** * compute.organizationSecurityPolicies.addRule - * @desc Inserts a rule into a security policy. (== suppress_warning http-rest-shadowed ==) + * @desc Inserts a rule into a security policy. * @alias compute.organizationSecurityPolicies.addRule * @memberOf! () * @@ -47847,7 +48170,7 @@ export namespace compute_alpha { /** * compute.organizationSecurityPolicies.copyRules - * @desc Copies rules to the specified security policy. (== suppress_warning http-rest-shadowed ==) + * @desc Copies rules to the specified security policy. * @alias compute.organizationSecurityPolicies.copyRules * @memberOf! () * @@ -47923,7 +48246,7 @@ export namespace compute_alpha { /** * compute.organizationSecurityPolicies.delete - * @desc Deletes the specified policy. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified policy. * @alias compute.organizationSecurityPolicies.delete * @memberOf! () * @@ -47998,7 +48321,7 @@ export namespace compute_alpha { /** * compute.organizationSecurityPolicies.get - * @desc List all of the ordered rules present in a single specified policy. (== suppress_warning http-rest-shadowed ==) + * @desc List all of the ordered rules present in a single specified policy. * @alias compute.organizationSecurityPolicies.get * @memberOf! () * @@ -48072,7 +48395,7 @@ export namespace compute_alpha { /** * compute.organizationSecurityPolicies.getAssociation - * @desc Gets an association with the specified name. (== suppress_warning http-rest-shadowed ==) + * @desc Gets an association with the specified name. * @alias compute.organizationSecurityPolicies.getAssociation * @memberOf! () * @@ -48154,7 +48477,7 @@ export namespace compute_alpha { /** * compute.organizationSecurityPolicies.getRule - * @desc Gets a rule at the specified priority. (== suppress_warning http-rest-shadowed ==) + * @desc Gets a rule at the specified priority. * @alias compute.organizationSecurityPolicies.getRule * @memberOf! () * @@ -48229,7 +48552,7 @@ export namespace compute_alpha { /** * compute.organizationSecurityPolicies.insert - * @desc Creates a new policy in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a new policy in the specified project using the data included in the request. * @alias compute.organizationSecurityPolicies.insert * @memberOf! () * @@ -48305,7 +48628,7 @@ export namespace compute_alpha { /** * compute.organizationSecurityPolicies.list - * @desc List all the policies that have been configured for the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc List all the policies that have been configured for the specified project. * @alias compute.organizationSecurityPolicies.list * @memberOf! () * @@ -48383,7 +48706,7 @@ export namespace compute_alpha { /** * compute.organizationSecurityPolicies.listAssociations - * @desc Lists associations of a specified target, i.e., organization or folder. (== suppress_warning http-rest-shadowed ==) + * @desc Lists associations of a specified target, i.e., organization or folder. * @alias compute.organizationSecurityPolicies.listAssociations * @memberOf! () * @@ -48483,7 +48806,7 @@ export namespace compute_alpha { /** * compute.organizationSecurityPolicies.move - * @desc Moves the specified security policy. (== suppress_warning http-rest-shadowed ==) + * @desc Moves the specified security policy. * @alias compute.organizationSecurityPolicies.move * @memberOf! () * @@ -48559,7 +48882,7 @@ export namespace compute_alpha { /** * compute.organizationSecurityPolicies.patch - * @desc Patches the specified policy with the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Patches the specified policy with the data included in the request. * @alias compute.organizationSecurityPolicies.patch * @memberOf! () * @@ -48635,7 +48958,7 @@ export namespace compute_alpha { /** * compute.organizationSecurityPolicies.patchRule - * @desc Patches a rule at the specified priority. (== suppress_warning http-rest-shadowed ==) + * @desc Patches a rule at the specified priority. * @alias compute.organizationSecurityPolicies.patchRule * @memberOf! () * @@ -48712,7 +49035,7 @@ export namespace compute_alpha { /** * compute.organizationSecurityPolicies.removeAssociation - * @desc Removes an association for the specified security policy. (== suppress_warning http-rest-shadowed ==) + * @desc Removes an association for the specified security policy. * @alias compute.organizationSecurityPolicies.removeAssociation * @memberOf! () * @@ -48788,7 +49111,7 @@ export namespace compute_alpha { /** * compute.organizationSecurityPolicies.removeRule - * @desc Deletes a rule at the specified priority. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes a rule at the specified priority. * @alias compute.organizationSecurityPolicies.removeRule * @memberOf! () * @@ -49165,12 +49488,13 @@ export namespace compute_alpha { /** * compute.packetMirrorings.aggregatedList - * @desc Retrieves an aggregated list of packetMirrorings. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of packetMirrorings. * @alias compute.packetMirrorings.aggregatedList * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. @@ -49252,7 +49576,7 @@ export namespace compute_alpha { /** * compute.packetMirrorings.delete - * @desc Deletes the specified PacketMirroring resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified PacketMirroring resource. * @alias compute.packetMirrorings.delete * @memberOf! () * @@ -49329,7 +49653,7 @@ export namespace compute_alpha { /** * compute.packetMirrorings.get - * @desc Returns the specified PacketMirroring resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified PacketMirroring resource. * @alias compute.packetMirrorings.get * @memberOf! () * @@ -49405,7 +49729,7 @@ export namespace compute_alpha { /** * compute.packetMirrorings.insert - * @desc Creates a PacketMirroring resource in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a PacketMirroring resource in the specified project and region using the data included in the request. * @alias compute.packetMirrorings.insert * @memberOf! () * @@ -49482,7 +49806,7 @@ export namespace compute_alpha { /** * compute.packetMirrorings.list - * @desc Retrieves a list of PacketMirroring resources available to the specified project and region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of PacketMirroring resources available to the specified project and region. * @alias compute.packetMirrorings.list * @memberOf! () * @@ -49561,7 +49885,7 @@ export namespace compute_alpha { /** * compute.packetMirrorings.patch - * @desc Patches the specified PacketMirroring resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Patches the specified PacketMirroring resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. * @alias compute.packetMirrorings.patch * @memberOf! () * @@ -49639,7 +49963,7 @@ export namespace compute_alpha { /** * compute.packetMirrorings.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.packetMirrorings.testIamPermissions * @memberOf! () * @@ -49730,6 +50054,10 @@ export namespace compute_alpha { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ @@ -49911,7 +50239,7 @@ export namespace compute_alpha { /** * compute.projects.disableXpnHost - * @desc Disable this project as a shared VPC host project. (== suppress_warning http-rest-shadowed ==) + * @desc Disable this project as a shared VPC host project. * @alias compute.projects.disableXpnHost * @memberOf! () * @@ -49985,7 +50313,7 @@ export namespace compute_alpha { /** * compute.projects.disableXpnResource - * @desc Disable a service resource (also known as service project) associated with this host project. (== suppress_warning http-rest-shadowed ==) + * @desc Disable a service resource (also known as service project) associated with this host project. * @alias compute.projects.disableXpnResource * @memberOf! () * @@ -50060,7 +50388,7 @@ export namespace compute_alpha { /** * compute.projects.enableXpnHost - * @desc Enable this project as a shared VPC host project. (== suppress_warning http-rest-shadowed ==) + * @desc Enable this project as a shared VPC host project. * @alias compute.projects.enableXpnHost * @memberOf! () * @@ -50134,7 +50462,7 @@ export namespace compute_alpha { /** * compute.projects.enableXpnResource - * @desc Enable service resource (a.k.a service project) for a host project, so that subnets in the host project can be used by instances in the service project. (== suppress_warning http-rest-shadowed ==) + * @desc Enable service resource (a.k.a service project) for a host project, so that subnets in the host project can be used by instances in the service project. * @alias compute.projects.enableXpnResource * @memberOf! () * @@ -50209,7 +50537,7 @@ export namespace compute_alpha { /** * compute.projects.get - * @desc Returns the specified Project resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified Project resource. * @alias compute.projects.get * @memberOf! () * @@ -50280,7 +50608,7 @@ export namespace compute_alpha { /** * compute.projects.getXpnHost - * @desc Gets the shared VPC host project that this project links to. May be empty if no link exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the shared VPC host project that this project links to. May be empty if no link exists. * @alias compute.projects.getXpnHost * @memberOf! () * @@ -50351,7 +50679,7 @@ export namespace compute_alpha { /** * compute.projects.getXpnResources - * @desc Gets service resources (a.k.a service project) associated with this host project. (== suppress_warning http-rest-shadowed ==) + * @desc Gets service resources (a.k.a service project) associated with this host project. * @alias compute.projects.getXpnResources * @memberOf! () * @@ -50432,7 +50760,7 @@ export namespace compute_alpha { /** * compute.projects.listXpnHosts - * @desc Lists all shared VPC host projects visible to the user in an organization. (== suppress_warning http-rest-shadowed ==) + * @desc Lists all shared VPC host projects visible to the user in an organization. * @alias compute.projects.listXpnHosts * @memberOf! () * @@ -50510,7 +50838,7 @@ export namespace compute_alpha { /** * compute.projects.moveDisk - * @desc Moves a persistent disk from one zone to another. (== suppress_warning http-rest-shadowed ==) + * @desc Moves a persistent disk from one zone to another. * @alias compute.projects.moveDisk * @memberOf! () * @@ -50585,7 +50913,7 @@ export namespace compute_alpha { /** * compute.projects.moveInstance - * @desc Moves an instance and its attached persistent disks from one zone to another. (== suppress_warning http-rest-shadowed ==) + * @desc Moves an instance and its attached persistent disks from one zone to another. * @alias compute.projects.moveInstance * @memberOf! () * @@ -50660,7 +50988,7 @@ export namespace compute_alpha { /** * compute.projects.setCommonInstanceMetadata - * @desc Sets metadata common to all instances within the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Sets metadata common to all instances within the specified project using the data included in the request. * @alias compute.projects.setCommonInstanceMetadata * @memberOf! () * @@ -50738,7 +51066,7 @@ export namespace compute_alpha { /** * compute.projects.setDefaultNetworkTier - * @desc Sets the default network tier of the project. The default network tier is used when an address/forwardingRule/instance is created without specifying the network tier field. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the default network tier of the project. The default network tier is used when an address/forwardingRule/instance is created without specifying the network tier field. * @alias compute.projects.setDefaultNetworkTier * @memberOf! () * @@ -50816,7 +51144,7 @@ export namespace compute_alpha { /** * compute.projects.setDefaultServiceAccount - * @desc Sets the default service account of the project. The default service account is used when a VM instance is created with the service account email address set to "default". (== suppress_warning http-rest-shadowed ==) + * @desc Sets the default service account of the project. The default service account is used when a VM instance is created with the service account email address set to "default". * @alias compute.projects.setDefaultServiceAccount * @memberOf! () * @@ -50894,7 +51222,7 @@ export namespace compute_alpha { /** * compute.projects.setUsageExportBucket - * @desc Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled. (== suppress_warning http-rest-shadowed ==) + * @desc Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled. * @alias compute.projects.setUsageExportBucket * @memberOf! () * @@ -51263,7 +51591,7 @@ export namespace compute_alpha { /** * compute.publicAdvertisedPrefixes.delete - * @desc Deletes the specified PublicAdvertisedPrefix (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified PublicAdvertisedPrefix * @alias compute.publicAdvertisedPrefixes.delete * @memberOf! () * @@ -51339,7 +51667,7 @@ export namespace compute_alpha { /** * compute.publicAdvertisedPrefixes.get - * @desc Returns the specified PublicAdvertisedPrefix resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified PublicAdvertisedPrefix resource. * @alias compute.publicAdvertisedPrefixes.get * @memberOf! () * @@ -51416,7 +51744,7 @@ export namespace compute_alpha { /** * compute.publicAdvertisedPrefixes.insert - * @desc Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request. * @alias compute.publicAdvertisedPrefixes.insert * @memberOf! () * @@ -51492,7 +51820,7 @@ export namespace compute_alpha { /** * compute.publicAdvertisedPrefixes.list - * @desc Lists the PublicAdvertisedPrefixes for a project. (== suppress_warning http-rest-shadowed ==) + * @desc Lists the PublicAdvertisedPrefixes for a project. * @alias compute.publicAdvertisedPrefixes.list * @memberOf! () * @@ -51577,7 +51905,7 @@ export namespace compute_alpha { /** * compute.publicAdvertisedPrefixes.patch - * @desc Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. * @alias compute.publicAdvertisedPrefixes.patch * @memberOf! () * @@ -51772,12 +52100,13 @@ export namespace compute_alpha { /** * compute.publicDelegatedPrefixes.aggregatedList - * @desc Lists all PublicDelegatedPrefix resources owned by the specific project across all scopes. (== suppress_warning http-rest-shadowed ==) + * @desc Lists all PublicDelegatedPrefix resources owned by the specific project across all scopes. * @alias compute.publicDelegatedPrefixes.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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. @@ -51861,7 +52190,7 @@ export namespace compute_alpha { /** * compute.publicDelegatedPrefixes.delete - * @desc Deletes the specified PublicDelegatedPrefix in the given region. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified PublicDelegatedPrefix in the given region. * @alias compute.publicDelegatedPrefixes.delete * @memberOf! () * @@ -51938,7 +52267,7 @@ export namespace compute_alpha { /** * compute.publicDelegatedPrefixes.get - * @desc Returns the specified PublicDelegatedPrefix resource in the given region. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified PublicDelegatedPrefix resource in the given region. * @alias compute.publicDelegatedPrefixes.get * @memberOf! () * @@ -52016,7 +52345,7 @@ export namespace compute_alpha { /** * compute.publicDelegatedPrefixes.insert - * @desc Creates a PublicDelegatedPrefix in the specified project in the given region using the parameters that are included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a PublicDelegatedPrefix in the specified project in the given region using the parameters that are included in the request. * @alias compute.publicDelegatedPrefixes.insert * @memberOf! () * @@ -52093,7 +52422,7 @@ export namespace compute_alpha { /** * compute.publicDelegatedPrefixes.list - * @desc Lists the PublicDelegatedPrefixes for a project in the given region. (== suppress_warning http-rest-shadowed ==) + * @desc Lists the PublicDelegatedPrefixes for a project in the given region. * @alias compute.publicDelegatedPrefixes.list * @memberOf! () * @@ -52179,7 +52508,7 @@ export namespace compute_alpha { /** * compute.publicDelegatedPrefixes.patch - * @desc Patches the specified PublicDelegatedPrefix resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Patches the specified PublicDelegatedPrefix resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. * @alias compute.publicDelegatedPrefixes.patch * @memberOf! () * @@ -52267,6 +52596,10 @@ export namespace compute_alpha { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ @@ -52423,7 +52756,7 @@ export namespace compute_alpha { /** * compute.regionAutoscalers.delete - * @desc Deletes the specified autoscaler. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified autoscaler. * @alias compute.regionAutoscalers.delete * @memberOf! () * @@ -52500,7 +52833,7 @@ export namespace compute_alpha { /** * compute.regionAutoscalers.get - * @desc Returns the specified autoscaler. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified autoscaler. * @alias compute.regionAutoscalers.get * @memberOf! () * @@ -52576,7 +52909,7 @@ export namespace compute_alpha { /** * compute.regionAutoscalers.insert - * @desc Creates an autoscaler in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates an autoscaler in the specified project using the data included in the request. * @alias compute.regionAutoscalers.insert * @memberOf! () * @@ -52653,7 +52986,7 @@ export namespace compute_alpha { /** * compute.regionAutoscalers.list - * @desc Retrieves a list of autoscalers contained within the specified region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of autoscalers contained within the specified region. * @alias compute.regionAutoscalers.list * @memberOf! () * @@ -52734,7 +53067,7 @@ export namespace compute_alpha { /** * compute.regionAutoscalers.patch - * @desc Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.regionAutoscalers.patch * @memberOf! () * @@ -52812,7 +53145,7 @@ export namespace compute_alpha { /** * compute.regionAutoscalers.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.regionAutoscalers.testIamPermissions * @memberOf! () * @@ -52893,7 +53226,7 @@ export namespace compute_alpha { /** * compute.regionAutoscalers.update - * @desc Updates an autoscaler in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Updates an autoscaler in the specified project using the data included in the request. * @alias compute.regionAutoscalers.update * @memberOf! () * @@ -53163,7 +53496,7 @@ export namespace compute_alpha { /** * compute.regionBackendServices.delete - * @desc Deletes the specified regional BackendService resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified regional BackendService resource. * @alias compute.regionBackendServices.delete * @memberOf! () * @@ -53240,7 +53573,7 @@ export namespace compute_alpha { /** * compute.regionBackendServices.get - * @desc Returns the specified regional BackendService resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified regional BackendService resource. * @alias compute.regionBackendServices.get * @memberOf! () * @@ -53316,7 +53649,7 @@ export namespace compute_alpha { /** * compute.regionBackendServices.getHealth - * @desc Gets the most recent health check results for this regional BackendService. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the most recent health check results for this regional BackendService. * @alias compute.regionBackendServices.getHealth * @memberOf! () * @@ -53400,7 +53733,7 @@ export namespace compute_alpha { /** * compute.regionBackendServices.insert - * @desc Creates a regional BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a regional backend service. Read Restrictions and Guidelines for more information. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a regional BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a regional backend service. Read Restrictions and Guidelines for more information. * @alias compute.regionBackendServices.insert * @memberOf! () * @@ -53477,7 +53810,7 @@ export namespace compute_alpha { /** * compute.regionBackendServices.list - * @desc Retrieves the list of regional BackendService resources available to the specified project in the given region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of regional BackendService resources available to the specified project in the given region. * @alias compute.regionBackendServices.list * @memberOf! () * @@ -53556,7 +53889,7 @@ export namespace compute_alpha { /** * compute.regionBackendServices.patch - * @desc Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.regionBackendServices.patch * @memberOf! () * @@ -53634,7 +53967,7 @@ export namespace compute_alpha { /** * compute.regionBackendServices.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.regionBackendServices.testIamPermissions * @memberOf! () * @@ -53715,7 +54048,7 @@ export namespace compute_alpha { /** * compute.regionBackendServices.update - * @desc Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. * @alias compute.regionBackendServices.update * @memberOf! () * @@ -54010,12 +54343,13 @@ export namespace compute_alpha { /** * compute.regionCommitments.aggregatedList - * @desc Retrieves an aggregated list of commitments. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of commitments. * @alias compute.regionCommitments.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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. @@ -54092,7 +54426,7 @@ export namespace compute_alpha { /** * compute.regionCommitments.get - * @desc Returns the specified commitment resource. Gets a list of available commitments by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified commitment resource. Gets a list of available commitments by making a list() request. * @alias compute.regionCommitments.get * @memberOf! () * @@ -54168,7 +54502,7 @@ export namespace compute_alpha { /** * compute.regionCommitments.insert - * @desc Creates a commitment in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a commitment in the specified project using the data included in the request. * @alias compute.regionCommitments.insert * @memberOf! () * @@ -54245,7 +54579,7 @@ export namespace compute_alpha { /** * compute.regionCommitments.list - * @desc Retrieves a list of commitments contained within the specified region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of commitments contained within the specified region. * @alias compute.regionCommitments.list * @memberOf! () * @@ -54324,7 +54658,7 @@ export namespace compute_alpha { /** * compute.regionCommitments.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.regionCommitments.testIamPermissions * @memberOf! () * @@ -54405,7 +54739,7 @@ export namespace compute_alpha { /** * compute.regionCommitments.updateReservations - * @desc Update the shape of reservations for GPUS/Local SSDs of reservations within the commitments. (== suppress_warning http-rest-shadowed ==) + * @desc Update the shape of reservations for GPUS/Local SSDs of reservations within the commitments. * @alias compute.regionCommitments.updateReservations * @memberOf! () * @@ -54493,6 +54827,10 @@ export namespace compute_alpha { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ @@ -54650,7 +54988,7 @@ export namespace compute_alpha { /** * compute.regionDisks.addResourcePolicies - * @desc Adds existing resource policies to a regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation. (== suppress_warning http-rest-shadowed ==) + * @desc Adds existing resource policies to a regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation. * @alias compute.regionDisks.addResourcePolicies * @memberOf! () * @@ -54728,7 +55066,7 @@ export namespace compute_alpha { /** * compute.regionDisks.createSnapshot - * @desc Creates a snapshot of this regional disk. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a snapshot of this regional disk. * @alias compute.regionDisks.createSnapshot * @memberOf! () * @@ -54807,7 +55145,7 @@ export namespace compute_alpha { /** * compute.regionDisks.delete - * @desc Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. * @alias compute.regionDisks.delete * @memberOf! () * @@ -54884,7 +55222,7 @@ export namespace compute_alpha { /** * compute.regionDisks.get - * @desc Returns a specified regional persistent disk. (== suppress_warning http-rest-shadowed ==) + * @desc Returns a specified regional persistent disk. * @alias compute.regionDisks.get * @memberOf! () * @@ -54957,7 +55295,7 @@ export namespace compute_alpha { /** * compute.regionDisks.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.regionDisks.getIamPolicy * @memberOf! () * @@ -55032,7 +55370,7 @@ export namespace compute_alpha { /** * compute.regionDisks.insert - * @desc Creates a persistent regional disk in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a persistent regional disk in the specified project using the data included in the request. * @alias compute.regionDisks.insert * @memberOf! () * @@ -55110,7 +55448,7 @@ export namespace compute_alpha { /** * compute.regionDisks.list - * @desc Retrieves the list of persistent disks contained within the specified region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of persistent disks contained within the specified region. * @alias compute.regionDisks.list * @memberOf! () * @@ -55186,7 +55524,7 @@ export namespace compute_alpha { /** * compute.regionDisks.removeResourcePolicies - * @desc Removes resource policies from a regional disk. (== suppress_warning http-rest-shadowed ==) + * @desc Removes resource policies from a regional disk. * @alias compute.regionDisks.removeResourcePolicies * @memberOf! () * @@ -55266,7 +55604,7 @@ export namespace compute_alpha { /** * compute.regionDisks.resize - * @desc Resizes the specified regional persistent disk. (== suppress_warning http-rest-shadowed ==) + * @desc Resizes the specified regional persistent disk. * @alias compute.regionDisks.resize * @memberOf! () * @@ -55344,7 +55682,7 @@ export namespace compute_alpha { /** * compute.regionDisks.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.regionDisks.setIamPolicy * @memberOf! () * @@ -55419,7 +55757,7 @@ export namespace compute_alpha { /** * compute.regionDisks.setLabels - * @desc Sets the labels on the target regional disk. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the labels on the target regional disk. * @alias compute.regionDisks.setLabels * @memberOf! () * @@ -55497,7 +55835,7 @@ export namespace compute_alpha { /** * compute.regionDisks.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.regionDisks.testIamPermissions * @memberOf! () * @@ -55912,7 +56250,7 @@ export namespace compute_alpha { /** * compute.regionDiskTypes.get - * @desc Returns the specified regional disk type. Gets a list of available disk types by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified regional disk type. Gets a list of available disk types by making a list() request. * @alias compute.regionDiskTypes.get * @memberOf! () * @@ -55986,7 +56324,7 @@ export namespace compute_alpha { /** * compute.regionDiskTypes.list - * @desc Retrieves a list of regional disk types available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of regional disk types available to the specified project. * @alias compute.regionDiskTypes.list * @memberOf! () * @@ -56125,7 +56463,7 @@ export namespace compute_alpha { /** * compute.regionHealthChecks.delete - * @desc Deletes the specified HealthCheck resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified HealthCheck resource. * @alias compute.regionHealthChecks.delete * @memberOf! () * @@ -56202,7 +56540,7 @@ export namespace compute_alpha { /** * compute.regionHealthChecks.get - * @desc Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. * @alias compute.regionHealthChecks.get * @memberOf! () * @@ -56278,7 +56616,7 @@ export namespace compute_alpha { /** * compute.regionHealthChecks.insert - * @desc Creates a HealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a HealthCheck resource in the specified project using the data included in the request. * @alias compute.regionHealthChecks.insert * @memberOf! () * @@ -56355,7 +56693,7 @@ export namespace compute_alpha { /** * compute.regionHealthChecks.list - * @desc Retrieves the list of HealthCheck resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of HealthCheck resources available to the specified project. * @alias compute.regionHealthChecks.list * @memberOf! () * @@ -56434,7 +56772,7 @@ export namespace compute_alpha { /** * compute.regionHealthChecks.patch - * @desc Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.regionHealthChecks.patch * @memberOf! () * @@ -56512,7 +56850,7 @@ export namespace compute_alpha { /** * compute.regionHealthChecks.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.regionHealthChecks.testIamPermissions * @memberOf! () * @@ -56593,7 +56931,7 @@ export namespace compute_alpha { /** * compute.regionHealthChecks.update - * @desc Updates a HealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. * @alias compute.regionHealthChecks.update * @memberOf! () * @@ -56863,7 +57201,7 @@ export namespace compute_alpha { /** * compute.regionHealthCheckServices.delete - * @desc Deletes the specified regional HealthCheckService. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified regional HealthCheckService. * @alias compute.regionHealthCheckServices.delete * @memberOf! () * @@ -56940,7 +57278,7 @@ export namespace compute_alpha { /** * compute.regionHealthCheckServices.get - * @desc Returns the specified regional HealthCheckService resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified regional HealthCheckService resource. * @alias compute.regionHealthCheckServices.get * @memberOf! () * @@ -57016,7 +57354,7 @@ export namespace compute_alpha { /** * compute.regionHealthCheckServices.insert - * @desc Creates a regional HealthCheckService resource in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a regional HealthCheckService resource in the specified project and region using the data included in the request. * @alias compute.regionHealthCheckServices.insert * @memberOf! () * @@ -57093,7 +57431,7 @@ export namespace compute_alpha { /** * compute.regionHealthCheckServices.list - * @desc Lists all the HealthCheckService resources that have been configured for the specified project in the given region. (== suppress_warning http-rest-shadowed ==) + * @desc Lists all the HealthCheckService resources that have been configured for the specified project in the given region. * @alias compute.regionHealthCheckServices.list * @memberOf! () * @@ -57174,7 +57512,7 @@ export namespace compute_alpha { /** * compute.regionHealthCheckServices.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.regionHealthCheckServices.testIamPermissions * @memberOf! () * @@ -57389,7 +57727,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.abandonInstances - * @desc Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. (== suppress_warning http-rest-shadowed ==) + * @desc Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @alias compute.regionInstanceGroupManagers.abandonInstances * @memberOf! () * @@ -57467,7 +57805,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.applyUpdatesToInstances - * @desc Apply updates to selected instances the managed instance group. (== suppress_warning http-rest-shadowed ==) + * @desc Apply updates to selected instances the managed instance group. * @alias compute.regionInstanceGroupManagers.applyUpdatesToInstances * @memberOf! () * @@ -57546,7 +57884,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.createInstances - * @desc Creates instances with per-instance configs in this regional managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method. (== suppress_warning http-rest-shadowed ==) + * @desc Creates instances with per-instance configs in this regional managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method. * @alias compute.regionInstanceGroupManagers.createInstances * @memberOf! () * @@ -57624,7 +57962,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.delete - * @desc Deletes the specified managed instance group and all of the instances in that group. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified managed instance group and all of the instances in that group. * @alias compute.regionInstanceGroupManagers.delete * @memberOf! () * @@ -57701,7 +58039,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.deleteInstances - * @desc Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. (== suppress_warning http-rest-shadowed ==) + * @desc Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @alias compute.regionInstanceGroupManagers.deleteInstances * @memberOf! () * @@ -57779,7 +58117,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.deletePerInstanceConfigs - * @desc Deletes selected per-instance configs for the managed instance group. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes selected per-instance configs for the managed instance group. * @alias compute.regionInstanceGroupManagers.deletePerInstanceConfigs * @memberOf! () * @@ -57858,7 +58196,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.get - * @desc Returns all of the details about the specified managed instance group. (== suppress_warning http-rest-shadowed ==) + * @desc Returns all of the details about the specified managed instance group. * @alias compute.regionInstanceGroupManagers.get * @memberOf! () * @@ -57936,7 +58274,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.insert - * @desc Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A regional managed instance group can contain up to 2000 instances. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A regional managed instance group can contain up to 2000 instances. * @alias compute.regionInstanceGroupManagers.insert * @memberOf! () * @@ -58013,7 +58351,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.list - * @desc Retrieves the list of managed instance groups that are contained within the specified region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of managed instance groups that are contained within the specified region. * @alias compute.regionInstanceGroupManagers.list * @memberOf! () * @@ -58101,7 +58439,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.listErrors - * @desc Lists all errors thrown by actions on instances for a given regional managed instance group. (== suppress_warning http-rest-shadowed ==) + * @desc Lists all errors thrown by actions on instances for a given regional managed instance group. * @alias compute.regionInstanceGroupManagers.listErrors * @memberOf! () * @@ -58206,7 +58544,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.listManagedInstances - * @desc Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. (== suppress_warning http-rest-shadowed ==) + * @desc Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. * @alias compute.regionInstanceGroupManagers.listManagedInstances * @memberOf! () * @@ -58310,7 +58648,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.listPerInstanceConfigs - * @desc Lists all of the per-instance configs defined for the managed instance group. (== suppress_warning http-rest-shadowed ==) + * @desc Lists all of the per-instance configs defined for the managed instance group. * @alias compute.regionInstanceGroupManagers.listPerInstanceConfigs * @memberOf! () * @@ -58414,7 +58752,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.patch - * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.regionInstanceGroupManagers.patch * @memberOf! () * @@ -58492,7 +58830,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.patchPerInstanceConfigs - * @desc Insert or patch (for the ones that already exist) per-instance configs for the managed instance group. perInstanceConfig.instance serves as a key used to distinguish whether to perform insert or patch. (== suppress_warning http-rest-shadowed ==) + * @desc Insert or patch (for the ones that already exist) per-instance configs for the managed instance group. perInstanceConfig.instance serves as a key used to distinguish whether to perform insert or patch. * @alias compute.regionInstanceGroupManagers.patchPerInstanceConfigs * @memberOf! () * @@ -58572,7 +58910,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.recreateInstances - * @desc Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. (== suppress_warning http-rest-shadowed ==) + * @desc Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @alias compute.regionInstanceGroupManagers.recreateInstances * @memberOf! () * @@ -58650,7 +58988,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.resize - * @desc Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. (== suppress_warning http-rest-shadowed ==) + * @desc Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. * @alias compute.regionInstanceGroupManagers.resize * @memberOf! () * @@ -58728,7 +59066,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.setAutoHealingPolicies - * @desc Modifies the autohealing policy for the instances in this managed instance group. [Deprecated] This method is deprecated. Please use Patch instead. (== suppress_warning http-rest-shadowed ==) + * @desc Modifies the autohealing policy for the instances in this managed instance group. [Deprecated] This method is deprecated. Please use Patch instead. * @alias compute.regionInstanceGroupManagers.setAutoHealingPolicies * @memberOf! () * @@ -58808,7 +59146,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.setInstanceTemplate - * @desc Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected. * @alias compute.regionInstanceGroupManagers.setInstanceTemplate * @memberOf! () * @@ -58886,7 +59224,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.setTargetPools - * @desc Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected. (== suppress_warning http-rest-shadowed ==) + * @desc Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected. * @alias compute.regionInstanceGroupManagers.setTargetPools * @memberOf! () * @@ -58964,7 +59302,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.regionInstanceGroupManagers.testIamPermissions * @memberOf! () * @@ -59045,7 +59383,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.update - * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method. (== suppress_warning http-rest-shadowed ==) + * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method. * @alias compute.regionInstanceGroupManagers.update * @memberOf! () * @@ -59123,7 +59461,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.updatePerInstanceConfigs - * @desc Insert or update (for the ones that already exist) per-instance configs for the managed instance group. perInstanceConfig.instance serves as a key used to distinguish whether to perform insert or patch. (== suppress_warning http-rest-shadowed ==) + * @desc Insert or update (for the ones that already exist) per-instance configs for the managed instance group. perInstanceConfig.instance serves as a key used to distinguish whether to perform insert or patch. * @alias compute.regionInstanceGroupManagers.updatePerInstanceConfigs * @memberOf! () * @@ -59842,7 +60180,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroups.get - * @desc Returns the specified instance group resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified instance group resource. * @alias compute.regionInstanceGroups.get * @memberOf! () * @@ -59918,7 +60256,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroups.list - * @desc Retrieves the list of instance group resources contained within the specified region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of instance group resources contained within the specified region. * @alias compute.regionInstanceGroups.list * @memberOf! () * @@ -59999,7 +60337,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroups.listInstances - * @desc Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. (== suppress_warning http-rest-shadowed ==) + * @desc Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. * @alias compute.regionInstanceGroups.listInstances * @memberOf! () * @@ -60089,7 +60427,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroups.setNamedPorts - * @desc Sets the named ports for the specified regional instance group. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the named ports for the specified regional instance group. * @alias compute.regionInstanceGroups.setNamedPorts * @memberOf! () * @@ -60167,7 +60505,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroups.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.regionInstanceGroups.testIamPermissions * @memberOf! () * @@ -60395,6 +60733,428 @@ export namespace compute_alpha { requestBody?: Schema$TestPermissionsRequest; } + export class Resource$Regionnetworkendpointgroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.regionNetworkEndpointGroups.delete + * @desc Deletes the specified network endpoint group. Note that the NEG cannot be deleted if it is configured as a backend of a backend service. + * @alias compute.regionNetworkEndpointGroups.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.region The name of the region 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 {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Regionnetworkendpointgroups$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Regionnetworkendpointgroups$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regionnetworkendpointgroups$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Regionnetworkendpointgroups$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionnetworkendpointgroups$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionnetworkendpointgroups$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'networkEndpointGroup'], + pathParams: ['networkEndpointGroup', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionNetworkEndpointGroups.get + * @desc Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request. + * @alias compute.regionNetworkEndpointGroups.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 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 + */ + get( + params?: Params$Resource$Regionnetworkendpointgroups$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regionnetworkendpointgroups$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regionnetworkendpointgroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regionnetworkendpointgroups$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionnetworkendpointgroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionnetworkendpointgroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'networkEndpointGroup'], + pathParams: ['networkEndpointGroup', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionNetworkEndpointGroups.insert + * @desc Creates a network endpoint group in the specified project using the parameters that are included in the request. + * @alias compute.regionNetworkEndpointGroups.insert + * @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 where you want to create the network endpoint group. 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 {().NetworkEndpointGroup} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Regionnetworkendpointgroups$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Regionnetworkendpointgroups$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regionnetworkendpointgroups$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Regionnetworkendpointgroups$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionnetworkendpointgroups$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionnetworkendpointgroups$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/networkEndpointGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionNetworkEndpointGroups.list + * @desc Retrieves the list of regional network endpoint groups available to the specified project in the given region. + * @alias compute.regionNetworkEndpointGroups.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 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?: Params$Resource$Regionnetworkendpointgroups$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regionnetworkendpointgroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regionnetworkendpointgroups$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Regionnetworkendpointgroups$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionnetworkendpointgroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionnetworkendpointgroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/networkEndpointGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regionnetworkendpointgroups$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the network endpoint group to delete. It should comply with RFC1035. + */ + networkEndpointGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region where the network endpoint group is located. It should comply with RFC1035. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Regionnetworkendpointgroups$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the network endpoint group. It should comply with RFC1035. + */ + networkEndpointGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region where the network endpoint group is located. It should comply with RFC1035. + */ + region?: string; + } + export interface Params$Resource$Regionnetworkendpointgroups$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region where you want to create the network endpoint group. It should comply with RFC1035. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NetworkEndpointGroup; + } + export interface Params$Resource$Regionnetworkendpointgroups$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region where the network endpoint group is located. It should comply with RFC1035. + */ + region?: string; + } + export class Resource$Regionnotificationendpoints { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -60403,7 +61163,7 @@ export namespace compute_alpha { /** * compute.regionNotificationEndpoints.delete - * @desc Deletes the specified NotificationEndpoint in the given region (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified NotificationEndpoint in the given region * @alias compute.regionNotificationEndpoints.delete * @memberOf! () * @@ -60480,7 +61240,7 @@ export namespace compute_alpha { /** * compute.regionNotificationEndpoints.get - * @desc Returns the specified NotificationEndpoint resource in the given region. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified NotificationEndpoint resource in the given region. * @alias compute.regionNotificationEndpoints.get * @memberOf! () * @@ -60558,7 +61318,7 @@ export namespace compute_alpha { /** * compute.regionNotificationEndpoints.insert - * @desc Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request. * @alias compute.regionNotificationEndpoints.insert * @memberOf! () * @@ -60635,7 +61395,7 @@ export namespace compute_alpha { /** * compute.regionNotificationEndpoints.list - * @desc Lists the NotificationEndpoints for a project in the given region. (== suppress_warning http-rest-shadowed ==) + * @desc Lists the NotificationEndpoints for a project in the given region. * @alias compute.regionNotificationEndpoints.list * @memberOf! () * @@ -60716,7 +61476,7 @@ export namespace compute_alpha { /** * compute.regionNotificationEndpoints.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.regionNotificationEndpoints.testIamPermissions * @memberOf! () * @@ -60931,7 +61691,7 @@ export namespace compute_alpha { /** * compute.regionOperations.delete - * @desc Deletes the specified region-specific Operations resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified region-specific Operations resource. * @alias compute.regionOperations.delete * @memberOf! () * @@ -61005,7 +61765,7 @@ export namespace compute_alpha { /** * compute.regionOperations.get - * @desc Retrieves the specified region-specific Operations resource. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the specified region-specific Operations resource. * @alias compute.regionOperations.get * @memberOf! () * @@ -61081,7 +61841,7 @@ export namespace compute_alpha { /** * compute.regionOperations.list - * @desc Retrieves a list of Operation resources contained within the specified region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of Operation resources contained within the specified region. * @alias compute.regionOperations.list * @memberOf! () * @@ -61160,7 +61920,7 @@ export namespace compute_alpha { /** * compute.regionOperations.wait - * @desc Waits for the specified region-specific Operations resource until it is done or timeout, and retrieves the specified Operations resource. 1. Immediately returns when the operation is already done. 2. Waits for no more than the default deadline (2 minutes, subject to change) and then returns the current state of the operation, which may be DONE or still in progress. 3. Is best-effort: a. The server can wait less than the default deadline or zero seconds, in overload situations. b. There is no guarantee that the operation is actually done when returns. 4. User should be prepared to retry if the operation is not DONE. (== suppress_warning http-rest-shadowed ==) + * @desc Waits for the specified region-specific Operations resource until it is done or timeout, and retrieves the specified Operations resource. 1. Immediately returns when the operation is already done. 2. Waits for no more than the default deadline (2 minutes, subject to change) and then returns the current state of the operation, which may be DONE or still in progress. 3. Is best-effort: a. The server can wait less than the default deadline or zero seconds, in overload situations. b. There is no guarantee that the operation is actually done when returns. 4. User should be prepared to retry if the operation is not DONE. * @alias compute.regionOperations.wait * @memberOf! () * @@ -61336,7 +62096,7 @@ export namespace compute_alpha { /** * compute.regions.get - * @desc Returns the specified Region resource. Gets a list of available regions by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified Region resource. Gets a list of available regions by making a list() request. * @alias compute.regions.get * @memberOf! () * @@ -61407,7 +62167,7 @@ export namespace compute_alpha { /** * compute.regions.list - * @desc Retrieves the list of region resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of region resources available to the specified project. * @alias compute.regions.list * @memberOf! () * @@ -61533,7 +62293,7 @@ export namespace compute_alpha { /** * compute.regionSslCertificates.delete - * @desc Deletes the specified SslCertificate resource in the region. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified SslCertificate resource in the region. * @alias compute.regionSslCertificates.delete * @memberOf! () * @@ -61610,7 +62370,7 @@ export namespace compute_alpha { /** * compute.regionSslCertificates.get - * @desc Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request. * @alias compute.regionSslCertificates.get * @memberOf! () * @@ -61686,7 +62446,7 @@ export namespace compute_alpha { /** * compute.regionSslCertificates.insert - * @desc Creates a SslCertificate resource in the specified project and region using the data included in the request (== suppress_warning http-rest-shadowed ==) + * @desc Creates a SslCertificate resource in the specified project and region using the data included in the request * @alias compute.regionSslCertificates.insert * @memberOf! () * @@ -61763,7 +62523,7 @@ export namespace compute_alpha { /** * compute.regionSslCertificates.list - * @desc Retrieves the list of SslCertificate resources available to the specified project in the specified region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of SslCertificate resources available to the specified project in the specified region. * @alias compute.regionSslCertificates.list * @memberOf! () * @@ -61842,7 +62602,7 @@ export namespace compute_alpha { /** * compute.regionSslCertificates.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource and region. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource and region. * @alias compute.regionSslCertificates.testIamPermissions * @memberOf! () * @@ -62057,7 +62817,7 @@ export namespace compute_alpha { /** * compute.regionTargetHttpProxies.delete - * @desc Deletes the specified TargetHttpProxy resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified TargetHttpProxy resource. * @alias compute.regionTargetHttpProxies.delete * @memberOf! () * @@ -62134,7 +62894,7 @@ export namespace compute_alpha { /** * compute.regionTargetHttpProxies.get - * @desc Returns the specified TargetHttpProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified TargetHttpProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request. * @alias compute.regionTargetHttpProxies.get * @memberOf! () * @@ -62210,7 +62970,7 @@ export namespace compute_alpha { /** * compute.regionTargetHttpProxies.insert - * @desc Creates a TargetHttpProxy resource in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a TargetHttpProxy resource in the specified project and region using the data included in the request. * @alias compute.regionTargetHttpProxies.insert * @memberOf! () * @@ -62287,7 +63047,7 @@ export namespace compute_alpha { /** * compute.regionTargetHttpProxies.list - * @desc Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region. * @alias compute.regionTargetHttpProxies.list * @memberOf! () * @@ -62366,7 +63126,7 @@ export namespace compute_alpha { /** * compute.regionTargetHttpProxies.setUrlMap - * @desc Changes the URL map for TargetHttpProxy. (== suppress_warning http-rest-shadowed ==) + * @desc Changes the URL map for TargetHttpProxy. * @alias compute.regionTargetHttpProxies.setUrlMap * @memberOf! () * @@ -62444,7 +63204,7 @@ export namespace compute_alpha { /** * compute.regionTargetHttpProxies.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.regionTargetHttpProxies.testIamPermissions * @memberOf! () * @@ -62688,7 +63448,7 @@ export namespace compute_alpha { /** * compute.regionTargetHttpsProxies.delete - * @desc Deletes the specified TargetHttpsProxy resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified TargetHttpsProxy resource. * @alias compute.regionTargetHttpsProxies.delete * @memberOf! () * @@ -62765,7 +63525,7 @@ export namespace compute_alpha { /** * compute.regionTargetHttpsProxies.get - * @desc Returns the specified TargetHttpsProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified TargetHttpsProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request. * @alias compute.regionTargetHttpsProxies.get * @memberOf! () * @@ -62841,7 +63601,7 @@ export namespace compute_alpha { /** * compute.regionTargetHttpsProxies.insert - * @desc Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request. * @alias compute.regionTargetHttpsProxies.insert * @memberOf! () * @@ -62918,7 +63678,7 @@ export namespace compute_alpha { /** * compute.regionTargetHttpsProxies.list - * @desc Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region. * @alias compute.regionTargetHttpsProxies.list * @memberOf! () * @@ -62999,7 +63759,7 @@ export namespace compute_alpha { /** * compute.regionTargetHttpsProxies.setSslCertificates - * @desc Replaces SslCertificates for TargetHttpsProxy. (== suppress_warning http-rest-shadowed ==) + * @desc Replaces SslCertificates for TargetHttpsProxy. * @alias compute.regionTargetHttpsProxies.setSslCertificates * @memberOf! () * @@ -63077,7 +63837,7 @@ export namespace compute_alpha { /** * compute.regionTargetHttpsProxies.setUrlMap - * @desc Changes the URL map for TargetHttpsProxy. (== suppress_warning http-rest-shadowed ==) + * @desc Changes the URL map for TargetHttpsProxy. * @alias compute.regionTargetHttpsProxies.setUrlMap * @memberOf! () * @@ -63155,7 +63915,7 @@ export namespace compute_alpha { /** * compute.regionTargetHttpsProxies.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.regionTargetHttpsProxies.testIamPermissions * @memberOf! () * @@ -63428,7 +64188,7 @@ export namespace compute_alpha { /** * compute.regionUrlMaps.delete - * @desc Deletes the specified UrlMap resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified UrlMap resource. * @alias compute.regionUrlMaps.delete * @memberOf! () * @@ -63505,7 +64265,7 @@ export namespace compute_alpha { /** * compute.regionUrlMaps.get - * @desc Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request. * @alias compute.regionUrlMaps.get * @memberOf! () * @@ -63579,7 +64339,7 @@ export namespace compute_alpha { /** * compute.regionUrlMaps.insert - * @desc Creates a UrlMap resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a UrlMap resource in the specified project using the data included in the request. * @alias compute.regionUrlMaps.insert * @memberOf! () * @@ -63656,7 +64416,7 @@ export namespace compute_alpha { /** * compute.regionUrlMaps.invalidateCache - * @desc Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. (== suppress_warning http-rest-shadowed ==) + * @desc Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. * @alias compute.regionUrlMaps.invalidateCache * @memberOf! () * @@ -63734,7 +64494,7 @@ export namespace compute_alpha { /** * compute.regionUrlMaps.list - * @desc Retrieves the list of UrlMap resources available to the specified project in the specified region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of UrlMap resources available to the specified project in the specified region. * @alias compute.regionUrlMaps.list * @memberOf! () * @@ -63813,7 +64573,7 @@ export namespace compute_alpha { /** * compute.regionUrlMaps.patch - * @desc Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. * @alias compute.regionUrlMaps.patch * @memberOf! () * @@ -63891,7 +64651,7 @@ export namespace compute_alpha { /** * compute.regionUrlMaps.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.regionUrlMaps.testIamPermissions * @memberOf! () * @@ -63972,7 +64732,7 @@ export namespace compute_alpha { /** * compute.regionUrlMaps.update - * @desc Updates the specified UrlMap resource with the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified UrlMap resource with the data included in the request. * @alias compute.regionUrlMaps.update * @memberOf! () * @@ -64050,7 +64810,7 @@ export namespace compute_alpha { /** * compute.regionUrlMaps.validate - * @desc Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap. (== suppress_warning http-rest-shadowed ==) + * @desc Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap. * @alias compute.regionUrlMaps.validate * @memberOf! () * @@ -64377,12 +65137,13 @@ export namespace compute_alpha { /** * compute.reservations.aggregatedList - * @desc Retrieves an aggregated list of reservations. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of reservations. * @alias compute.reservations.aggregatedList * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. @@ -64462,7 +65223,7 @@ export namespace compute_alpha { /** * compute.reservations.delete - * @desc Deletes the specified reservation. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified reservation. * @alias compute.reservations.delete * @memberOf! () * @@ -64539,7 +65300,7 @@ export namespace compute_alpha { /** * compute.reservations.get - * @desc Retrieves information about the specified reservation. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves information about the specified reservation. * @alias compute.reservations.get * @memberOf! () * @@ -64614,7 +65375,7 @@ export namespace compute_alpha { /** * compute.reservations.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.reservations.getIamPolicy * @memberOf! () * @@ -64689,7 +65450,7 @@ export namespace compute_alpha { /** * compute.reservations.insert - * @desc Creates a new reservation. For more information, read Reserving zonal resources. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a new reservation. For more information, read Reserving zonal resources. * @alias compute.reservations.insert * @memberOf! () * @@ -64766,7 +65527,7 @@ export namespace compute_alpha { /** * compute.reservations.list - * @desc A list of all the reservations that have been configured for the specified project in specified zone. (== suppress_warning http-rest-shadowed ==) + * @desc A list of all the reservations that have been configured for the specified project in specified zone. * @alias compute.reservations.list * @memberOf! () * @@ -64845,7 +65606,7 @@ export namespace compute_alpha { /** * compute.reservations.resize - * @desc Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations. (== suppress_warning http-rest-shadowed ==) + * @desc Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations. * @alias compute.reservations.resize * @memberOf! () * @@ -64923,7 +65684,7 @@ export namespace compute_alpha { /** * compute.reservations.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.reservations.setIamPolicy * @memberOf! () * @@ -64998,7 +65759,7 @@ export namespace compute_alpha { /** * compute.reservations.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.reservations.testIamPermissions * @memberOf! () * @@ -65089,6 +65850,10 @@ export namespace compute_alpha { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ @@ -65318,12 +66083,13 @@ export namespace compute_alpha { /** * compute.resourcePolicies.aggregatedList - * @desc Retrieves an aggregated list of resource policies. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of resource policies. * @alias compute.resourcePolicies.aggregatedList * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. @@ -65405,7 +66171,7 @@ export namespace compute_alpha { /** * compute.resourcePolicies.delete - * @desc Deletes the specified resource policy. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified resource policy. * @alias compute.resourcePolicies.delete * @memberOf! () * @@ -65482,7 +66248,7 @@ export namespace compute_alpha { /** * compute.resourcePolicies.get - * @desc Retrieves all information of the specified resource policy. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves all information of the specified resource policy. * @alias compute.resourcePolicies.get * @memberOf! () * @@ -65558,7 +66324,7 @@ export namespace compute_alpha { /** * compute.resourcePolicies.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.resourcePolicies.getIamPolicy * @memberOf! () * @@ -65633,7 +66399,7 @@ export namespace compute_alpha { /** * compute.resourcePolicies.insert - * @desc Creates a new resource policy. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a new resource policy. * @alias compute.resourcePolicies.insert * @memberOf! () * @@ -65710,7 +66476,7 @@ export namespace compute_alpha { /** * compute.resourcePolicies.list - * @desc A list all the resource policies that have been configured for the specified project in specified region. (== suppress_warning http-rest-shadowed ==) + * @desc A list all the resource policies that have been configured for the specified project in specified region. * @alias compute.resourcePolicies.list * @memberOf! () * @@ -65789,7 +66555,7 @@ export namespace compute_alpha { /** * compute.resourcePolicies.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.resourcePolicies.setIamPolicy * @memberOf! () * @@ -65864,7 +66630,7 @@ export namespace compute_alpha { /** * compute.resourcePolicies.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.resourcePolicies.testIamPermissions * @memberOf! () * @@ -65955,6 +66721,10 @@ export namespace compute_alpha { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ @@ -66156,12 +66926,13 @@ export namespace compute_alpha { /** * compute.routers.aggregatedList - * @desc Retrieves an aggregated list of routers. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of routers. * @alias compute.routers.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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. @@ -66237,7 +67008,7 @@ export namespace compute_alpha { /** * compute.routers.delete - * @desc Deletes the specified Router resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified Router resource. * @alias compute.routers.delete * @memberOf! () * @@ -66313,7 +67084,7 @@ export namespace compute_alpha { /** * compute.routers.get - * @desc Returns the specified Router resource. Gets a list of available routers by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified Router resource. Gets a list of available routers by making a list() request. * @alias compute.routers.get * @memberOf! () * @@ -66386,7 +67157,7 @@ export namespace compute_alpha { /** * compute.routers.getNatMappingInfo - * @desc Retrieves runtime Nat mapping information of VM endpoints. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves runtime Nat mapping information of VM endpoints. * @alias compute.routers.getNatMappingInfo * @memberOf! () * @@ -66474,7 +67245,7 @@ export namespace compute_alpha { /** * compute.routers.getRouterStatus - * @desc Retrieves runtime information of the specified router. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves runtime information of the specified router. * @alias compute.routers.getRouterStatus * @memberOf! () * @@ -66554,7 +67325,7 @@ export namespace compute_alpha { /** * compute.routers.insert - * @desc Creates a Router resource in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a Router resource in the specified project and region using the data included in the request. * @alias compute.routers.insert * @memberOf! () * @@ -66630,7 +67401,7 @@ export namespace compute_alpha { /** * compute.routers.list - * @desc Retrieves a list of Router resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of Router resources available to the specified project. * @alias compute.routers.list * @memberOf! () * @@ -66708,7 +67479,7 @@ export namespace compute_alpha { /** * compute.routers.patch - * @desc Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. * @alias compute.routers.patch * @memberOf! () * @@ -66785,7 +67556,7 @@ export namespace compute_alpha { /** * compute.routers.preview - * @desc Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router. (== suppress_warning http-rest-shadowed ==) + * @desc Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router. * @alias compute.routers.preview * @memberOf! () * @@ -66865,7 +67636,7 @@ export namespace compute_alpha { /** * compute.routers.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.routers.testIamPermissions * @memberOf! () * @@ -66946,7 +67717,7 @@ export namespace compute_alpha { /** * compute.routers.update - * @desc Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload. * @alias compute.routers.update * @memberOf! () * @@ -67033,6 +67804,10 @@ export namespace compute_alpha { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ @@ -67321,7 +68096,7 @@ export namespace compute_alpha { /** * compute.routes.delete - * @desc Deletes the specified Route resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified Route resource. * @alias compute.routes.delete * @memberOf! () * @@ -67396,7 +68171,7 @@ export namespace compute_alpha { /** * compute.routes.get - * @desc Returns the specified Route resource. Gets a list of available routes by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified Route resource. Gets a list of available routes by making a list() request. * @alias compute.routes.get * @memberOf! () * @@ -67468,7 +68243,7 @@ export namespace compute_alpha { /** * compute.routes.insert - * @desc Creates a Route resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a Route resource in the specified project using the data included in the request. * @alias compute.routes.insert * @memberOf! () * @@ -67542,7 +68317,7 @@ export namespace compute_alpha { /** * compute.routes.list - * @desc Retrieves the list of Route resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of Route resources available to the specified project. * @alias compute.routes.list * @memberOf! () * @@ -67618,7 +68393,7 @@ export namespace compute_alpha { /** * compute.routes.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.routes.testIamPermissions * @memberOf! () * @@ -67808,7 +68583,7 @@ export namespace compute_alpha { /** * compute.securityPolicies.addRule - * @desc Inserts a rule into a security policy. (== suppress_warning http-rest-shadowed ==) + * @desc Inserts a rule into a security policy. * @alias compute.securityPolicies.addRule * @memberOf! () * @@ -67885,7 +68660,7 @@ export namespace compute_alpha { /** * compute.securityPolicies.delete - * @desc Deletes the specified policy. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified policy. * @alias compute.securityPolicies.delete * @memberOf! () * @@ -67961,7 +68736,7 @@ export namespace compute_alpha { /** * compute.securityPolicies.get - * @desc List all of the ordered rules present in a single specified policy. (== suppress_warning http-rest-shadowed ==) + * @desc List all of the ordered rules present in a single specified policy. * @alias compute.securityPolicies.get * @memberOf! () * @@ -68036,7 +68811,7 @@ export namespace compute_alpha { /** * compute.securityPolicies.getRule - * @desc Gets a rule at the specified priority. (== suppress_warning http-rest-shadowed ==) + * @desc Gets a rule at the specified priority. * @alias compute.securityPolicies.getRule * @memberOf! () * @@ -68112,7 +68887,7 @@ export namespace compute_alpha { /** * compute.securityPolicies.insert - * @desc Creates a new policy in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a new policy in the specified project using the data included in the request. * @alias compute.securityPolicies.insert * @memberOf! () * @@ -68189,7 +68964,7 @@ export namespace compute_alpha { /** * compute.securityPolicies.list - * @desc List all the policies that have been configured for the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc List all the policies that have been configured for the specified project. * @alias compute.securityPolicies.list * @memberOf! () * @@ -68267,7 +69042,7 @@ export namespace compute_alpha { /** * compute.securityPolicies.listPreconfiguredExpressionSets - * @desc Gets the current list of preconfigured Web Application Firewall (WAF) expressions. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the current list of preconfigured Web Application Firewall (WAF) expressions. * @alias compute.securityPolicies.listPreconfiguredExpressionSets * @memberOf! () * @@ -68371,7 +69146,7 @@ export namespace compute_alpha { /** * compute.securityPolicies.patch - * @desc Patches the specified policy with the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Patches the specified policy with the data included in the request. * @alias compute.securityPolicies.patch * @memberOf! () * @@ -68448,7 +69223,7 @@ export namespace compute_alpha { /** * compute.securityPolicies.patchRule - * @desc Patches a rule at the specified priority. (== suppress_warning http-rest-shadowed ==) + * @desc Patches a rule at the specified priority. * @alias compute.securityPolicies.patchRule * @memberOf! () * @@ -68526,7 +69301,7 @@ export namespace compute_alpha { /** * compute.securityPolicies.removeRule - * @desc Deletes a rule at the specified priority. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes a rule at the specified priority. * @alias compute.securityPolicies.removeRule * @memberOf! () * @@ -68602,7 +69377,7 @@ export namespace compute_alpha { /** * compute.securityPolicies.setLabels - * @desc Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation. * @alias compute.securityPolicies.setLabels * @memberOf! () * @@ -68678,7 +69453,7 @@ export namespace compute_alpha { /** * compute.securityPolicies.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.securityPolicies.testIamPermissions * @memberOf! () * @@ -69044,7 +69819,7 @@ export namespace compute_alpha { /** * compute.snapshots.delete - * @desc Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snapshots. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snapshots. * @alias compute.snapshots.delete * @memberOf! () * @@ -69119,7 +69894,7 @@ export namespace compute_alpha { /** * compute.snapshots.get - * @desc Returns the specified Snapshot resource. Gets a list of available snapshots by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified Snapshot resource. Gets a list of available snapshots by making a list() request. * @alias compute.snapshots.get * @memberOf! () * @@ -69191,7 +69966,7 @@ export namespace compute_alpha { /** * compute.snapshots.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.snapshots.getIamPolicy * @memberOf! () * @@ -69265,7 +70040,7 @@ export namespace compute_alpha { /** * compute.snapshots.list - * @desc Retrieves the list of Snapshot resources contained within the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of Snapshot resources contained within the specified project. * @alias compute.snapshots.list * @memberOf! () * @@ -69341,7 +70116,7 @@ export namespace compute_alpha { /** * compute.snapshots.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.snapshots.setIamPolicy * @memberOf! () * @@ -69415,7 +70190,7 @@ export namespace compute_alpha { /** * compute.snapshots.setLabels - * @desc Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation. * @alias compute.snapshots.setLabels * @memberOf! () * @@ -69491,7 +70266,7 @@ export namespace compute_alpha { /** * compute.snapshots.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.snapshots.testIamPermissions * @memberOf! () * @@ -69723,12 +70498,13 @@ export namespace compute_alpha { /** * compute.sslCertificates.aggregatedList - * @desc Retrieves the list of all SslCertificate resources, regional and global, available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of all SslCertificate resources, regional and global, available to the specified project. * @alias compute.sslCertificates.aggregatedList * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. @@ -69810,7 +70586,7 @@ export namespace compute_alpha { /** * compute.sslCertificates.delete - * @desc Deletes the specified SslCertificate resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified SslCertificate resource. * @alias compute.sslCertificates.delete * @memberOf! () * @@ -69886,7 +70662,7 @@ export namespace compute_alpha { /** * compute.sslCertificates.get - * @desc Returns the specified SslCertificate resource. Gets a list of available SSL certificates by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified SslCertificate resource. Gets a list of available SSL certificates by making a list() request. * @alias compute.sslCertificates.get * @memberOf! () * @@ -69961,7 +70737,7 @@ export namespace compute_alpha { /** * compute.sslCertificates.insert - * @desc Creates a SslCertificate resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a SslCertificate resource in the specified project using the data included in the request. * @alias compute.sslCertificates.insert * @memberOf! () * @@ -70037,7 +70813,7 @@ export namespace compute_alpha { /** * compute.sslCertificates.list - * @desc Retrieves the list of SslCertificate resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of SslCertificate resources available to the specified project. * @alias compute.sslCertificates.list * @memberOf! () * @@ -70115,7 +70891,7 @@ export namespace compute_alpha { /** * compute.sslCertificates.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.sslCertificates.testIamPermissions * @memberOf! () * @@ -70205,6 +70981,10 @@ export namespace compute_alpha { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ @@ -70337,7 +71117,7 @@ export namespace compute_alpha { /** * compute.sslPolicies.delete - * @desc Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources. * @alias compute.sslPolicies.delete * @memberOf! () * @@ -70413,7 +71193,7 @@ export namespace compute_alpha { /** * compute.sslPolicies.get - * @desc Lists all of the ordered rules present in a single specified policy. (== suppress_warning http-rest-shadowed ==) + * @desc Lists all of the ordered rules present in a single specified policy. * @alias compute.sslPolicies.get * @memberOf! () * @@ -70487,7 +71267,7 @@ export namespace compute_alpha { /** * compute.sslPolicies.insert - * @desc Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() request. * @alias compute.sslPolicies.insert * @memberOf! () * @@ -70562,7 +71342,7 @@ export namespace compute_alpha { /** * compute.sslPolicies.list - * @desc Lists all the SSL policies that have been configured for the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Lists all the SSL policies that have been configured for the specified project. * @alias compute.sslPolicies.list * @memberOf! () * @@ -70638,7 +71418,7 @@ export namespace compute_alpha { /** * compute.sslPolicies.listAvailableFeatures - * @desc Lists all features that can be specified in the SSL policy when using custom profile. (== suppress_warning http-rest-shadowed ==) + * @desc Lists all features that can be specified in the SSL policy when using custom profile. * @alias compute.sslPolicies.listAvailableFeatures * @memberOf! () * @@ -70733,7 +71513,7 @@ export namespace compute_alpha { /** * compute.sslPolicies.patch - * @desc Patches the specified SSL policy with the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Patches the specified SSL policy with the data included in the request. * @alias compute.sslPolicies.patch * @memberOf! () * @@ -70810,7 +71590,7 @@ export namespace compute_alpha { /** * compute.sslPolicies.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.sslPolicies.testIamPermissions * @memberOf! () * @@ -71055,12 +71835,13 @@ export namespace compute_alpha { /** * compute.subnetworks.aggregatedList - * @desc Retrieves an aggregated list of subnetworks. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of subnetworks. * @alias compute.subnetworks.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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. @@ -71137,7 +71918,7 @@ export namespace compute_alpha { /** * compute.subnetworks.delete - * @desc Deletes the specified subnetwork. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified subnetwork. * @alias compute.subnetworks.delete * @memberOf! () * @@ -71214,7 +71995,7 @@ export namespace compute_alpha { /** * compute.subnetworks.expandIpCidrRange - * @desc Expands the IP CIDR range of the subnetwork to a specified value. (== suppress_warning http-rest-shadowed ==) + * @desc Expands the IP CIDR range of the subnetwork to a specified value. * @alias compute.subnetworks.expandIpCidrRange * @memberOf! () * @@ -71292,7 +72073,7 @@ export namespace compute_alpha { /** * compute.subnetworks.get - * @desc Returns the specified subnetwork. Gets a list of available subnetworks list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified subnetwork. Gets a list of available subnetworks list() request. * @alias compute.subnetworks.get * @memberOf! () * @@ -71367,7 +72148,7 @@ export namespace compute_alpha { /** * compute.subnetworks.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.subnetworks.getIamPolicy * @memberOf! () * @@ -71442,7 +72223,7 @@ export namespace compute_alpha { /** * compute.subnetworks.insert - * @desc Creates a subnetwork in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a subnetwork in the specified project using the data included in the request. * @alias compute.subnetworks.insert * @memberOf! () * @@ -71519,7 +72300,7 @@ export namespace compute_alpha { /** * compute.subnetworks.list - * @desc Retrieves a list of subnetworks available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of subnetworks available to the specified project. * @alias compute.subnetworks.list * @memberOf! () * @@ -71597,7 +72378,7 @@ export namespace compute_alpha { /** * compute.subnetworks.listUsable - * @desc Retrieves an aggregated list of all usable subnetworks in the project. The list contains all of the subnetworks in the project and the subnetworks that were shared by a Shared VPC host project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of all usable subnetworks in the project. The list contains all of the subnetworks in the project and the subnetworks that were shared by a Shared VPC host project. * @alias compute.subnetworks.listUsable * @memberOf! () * @@ -71684,7 +72465,7 @@ export namespace compute_alpha { /** * compute.subnetworks.patch - * @desc Patches the specified subnetwork with the data included in the request. Only certain fields can up updated with a patch request as indicated in the field descriptions. You must specify the current fingeprint of the subnetwork resource being patched. (== suppress_warning http-rest-shadowed ==) + * @desc Patches the specified subnetwork with the data included in the request. Only certain fields can up updated with a patch request as indicated in the field descriptions. You must specify the current fingeprint of the subnetwork resource being patched. * @alias compute.subnetworks.patch * @memberOf! () * @@ -71763,7 +72544,7 @@ export namespace compute_alpha { /** * compute.subnetworks.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.subnetworks.setIamPolicy * @memberOf! () * @@ -71838,7 +72619,7 @@ export namespace compute_alpha { /** * compute.subnetworks.setPrivateIpGoogleAccess - * @desc Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access. (== suppress_warning http-rest-shadowed ==) + * @desc Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access. * @alias compute.subnetworks.setPrivateIpGoogleAccess * @memberOf! () * @@ -71918,7 +72699,7 @@ export namespace compute_alpha { /** * compute.subnetworks.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.subnetworks.testIamPermissions * @memberOf! () * @@ -72009,6 +72790,10 @@ export namespace compute_alpha { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ @@ -72327,12 +73112,13 @@ export namespace compute_alpha { /** * compute.targetHttpProxies.aggregatedList - * @desc Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project. * @alias compute.targetHttpProxies.aggregatedList * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. @@ -72414,7 +73200,7 @@ export namespace compute_alpha { /** * compute.targetHttpProxies.delete - * @desc Deletes the specified TargetHttpProxy resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified TargetHttpProxy resource. * @alias compute.targetHttpProxies.delete * @memberOf! () * @@ -72490,7 +73276,7 @@ export namespace compute_alpha { /** * compute.targetHttpProxies.get - * @desc Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() request. * @alias compute.targetHttpProxies.get * @memberOf! () * @@ -72565,7 +73351,7 @@ export namespace compute_alpha { /** * compute.targetHttpProxies.insert - * @desc Creates a TargetHttpProxy resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a TargetHttpProxy resource in the specified project using the data included in the request. * @alias compute.targetHttpProxies.insert * @memberOf! () * @@ -72641,7 +73427,7 @@ export namespace compute_alpha { /** * compute.targetHttpProxies.list - * @desc Retrieves the list of TargetHttpProxy resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of TargetHttpProxy resources available to the specified project. * @alias compute.targetHttpProxies.list * @memberOf! () * @@ -72719,7 +73505,7 @@ export namespace compute_alpha { /** * compute.targetHttpProxies.setUrlMap - * @desc Changes the URL map for TargetHttpProxy. (== suppress_warning http-rest-shadowed ==) + * @desc Changes the URL map for TargetHttpProxy. * @alias compute.targetHttpProxies.setUrlMap * @memberOf! () * @@ -72796,7 +73582,7 @@ export namespace compute_alpha { /** * compute.targetHttpProxies.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.targetHttpProxies.testIamPermissions * @memberOf! () * @@ -72886,6 +73672,10 @@ export namespace compute_alpha { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ @@ -73043,12 +73833,13 @@ export namespace compute_alpha { /** * compute.targetHttpsProxies.aggregatedList - * @desc Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project. * @alias compute.targetHttpsProxies.aggregatedList * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. @@ -73130,7 +73921,7 @@ export namespace compute_alpha { /** * compute.targetHttpsProxies.delete - * @desc Deletes the specified TargetHttpsProxy resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified TargetHttpsProxy resource. * @alias compute.targetHttpsProxies.delete * @memberOf! () * @@ -73206,7 +73997,7 @@ export namespace compute_alpha { /** * compute.targetHttpsProxies.get - * @desc Returns the specified TargetHttpsProxy resource. Gets a list of available target HTTPS proxies by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified TargetHttpsProxy resource. Gets a list of available target HTTPS proxies by making a list() request. * @alias compute.targetHttpsProxies.get * @memberOf! () * @@ -73281,7 +74072,7 @@ export namespace compute_alpha { /** * compute.targetHttpsProxies.insert - * @desc Creates a TargetHttpsProxy resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a TargetHttpsProxy resource in the specified project using the data included in the request. * @alias compute.targetHttpsProxies.insert * @memberOf! () * @@ -73357,7 +74148,7 @@ export namespace compute_alpha { /** * compute.targetHttpsProxies.list - * @desc Retrieves the list of TargetHttpsProxy resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of TargetHttpsProxy resources available to the specified project. * @alias compute.targetHttpsProxies.list * @memberOf! () * @@ -73437,7 +74228,7 @@ export namespace compute_alpha { /** * compute.targetHttpsProxies.setQuicOverride - * @desc Sets the QUIC override policy for TargetHttpsProxy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the QUIC override policy for TargetHttpsProxy. * @alias compute.targetHttpsProxies.setQuicOverride * @memberOf! () * @@ -73514,7 +74305,7 @@ export namespace compute_alpha { /** * compute.targetHttpsProxies.setSslCertificates - * @desc Replaces SslCertificates for TargetHttpsProxy. (== suppress_warning http-rest-shadowed ==) + * @desc Replaces SslCertificates for TargetHttpsProxy. * @alias compute.targetHttpsProxies.setSslCertificates * @memberOf! () * @@ -73591,7 +74382,7 @@ export namespace compute_alpha { /** * compute.targetHttpsProxies.setSslPolicy - * @desc Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends. * @alias compute.targetHttpsProxies.setSslPolicy * @memberOf! () * @@ -73668,7 +74459,7 @@ export namespace compute_alpha { /** * compute.targetHttpsProxies.setUrlMap - * @desc Changes the URL map for TargetHttpsProxy. (== suppress_warning http-rest-shadowed ==) + * @desc Changes the URL map for TargetHttpsProxy. * @alias compute.targetHttpsProxies.setUrlMap * @memberOf! () * @@ -73745,7 +74536,7 @@ export namespace compute_alpha { /** * compute.targetHttpsProxies.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.targetHttpsProxies.testIamPermissions * @memberOf! () * @@ -73835,6 +74626,10 @@ export namespace compute_alpha { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ @@ -74067,12 +74862,13 @@ export namespace compute_alpha { /** * compute.targetInstances.aggregatedList - * @desc Retrieves an aggregated list of target instances. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of target instances. * @alias compute.targetInstances.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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. @@ -74154,7 +74950,7 @@ export namespace compute_alpha { /** * compute.targetInstances.delete - * @desc Deletes the specified TargetInstance resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified TargetInstance resource. * @alias compute.targetInstances.delete * @memberOf! () * @@ -74231,7 +75027,7 @@ export namespace compute_alpha { /** * compute.targetInstances.get - * @desc Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request. * @alias compute.targetInstances.get * @memberOf! () * @@ -74307,7 +75103,7 @@ export namespace compute_alpha { /** * compute.targetInstances.insert - * @desc Creates a TargetInstance resource in the specified project and zone using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a TargetInstance resource in the specified project and zone using the data included in the request. * @alias compute.targetInstances.insert * @memberOf! () * @@ -74384,7 +75180,7 @@ export namespace compute_alpha { /** * compute.targetInstances.list - * @desc Retrieves a list of TargetInstance resources available to the specified project and zone. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of TargetInstance resources available to the specified project and zone. * @alias compute.targetInstances.list * @memberOf! () * @@ -74463,7 +75259,7 @@ export namespace compute_alpha { /** * compute.targetInstances.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.targetInstances.testIamPermissions * @memberOf! () * @@ -74554,6 +75350,10 @@ export namespace compute_alpha { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ @@ -74706,7 +75506,7 @@ export namespace compute_alpha { /** * compute.targetPools.addHealthCheck - * @desc Adds health check URLs to a target pool. (== suppress_warning http-rest-shadowed ==) + * @desc Adds health check URLs to a target pool. * @alias compute.targetPools.addHealthCheck * @memberOf! () * @@ -74784,7 +75584,7 @@ export namespace compute_alpha { /** * compute.targetPools.addInstance - * @desc Adds an instance to a target pool. (== suppress_warning http-rest-shadowed ==) + * @desc Adds an instance to a target pool. * @alias compute.targetPools.addInstance * @memberOf! () * @@ -74862,12 +75662,13 @@ export namespace compute_alpha { /** * compute.targetPools.aggregatedList - * @desc Retrieves an aggregated list of target pools. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of target pools. * @alias compute.targetPools.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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. @@ -74944,7 +75745,7 @@ export namespace compute_alpha { /** * compute.targetPools.delete - * @desc Deletes the specified target pool. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified target pool. * @alias compute.targetPools.delete * @memberOf! () * @@ -75021,7 +75822,7 @@ export namespace compute_alpha { /** * compute.targetPools.get - * @desc Returns the specified target pool. Gets a list of available target pools by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified target pool. Gets a list of available target pools by making a list() request. * @alias compute.targetPools.get * @memberOf! () * @@ -75096,7 +75897,7 @@ export namespace compute_alpha { /** * compute.targetPools.getHealth - * @desc Gets the most recent health check results for each IP for the instance that is referenced by the given target pool. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the most recent health check results for each IP for the instance that is referenced by the given target pool. * @alias compute.targetPools.getHealth * @memberOf! () * @@ -75177,7 +75978,7 @@ export namespace compute_alpha { /** * compute.targetPools.insert - * @desc Creates a target pool in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a target pool in the specified project and region using the data included in the request. * @alias compute.targetPools.insert * @memberOf! () * @@ -75254,7 +76055,7 @@ export namespace compute_alpha { /** * compute.targetPools.list - * @desc Retrieves a list of target pools available to the specified project and region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of target pools available to the specified project and region. * @alias compute.targetPools.list * @memberOf! () * @@ -75332,7 +76133,7 @@ export namespace compute_alpha { /** * compute.targetPools.removeHealthCheck - * @desc Removes health check URL from a target pool. (== suppress_warning http-rest-shadowed ==) + * @desc Removes health check URL from a target pool. * @alias compute.targetPools.removeHealthCheck * @memberOf! () * @@ -75410,7 +76211,7 @@ export namespace compute_alpha { /** * compute.targetPools.removeInstance - * @desc Removes instance URL from a target pool. (== suppress_warning http-rest-shadowed ==) + * @desc Removes instance URL from a target pool. * @alias compute.targetPools.removeInstance * @memberOf! () * @@ -75488,7 +76289,7 @@ export namespace compute_alpha { /** * compute.targetPools.setBackup - * @desc Changes a backup target pool's configurations. (== suppress_warning http-rest-shadowed ==) + * @desc Changes a backup target pool's configurations. * @alias compute.targetPools.setBackup * @memberOf! () * @@ -75567,7 +76368,7 @@ export namespace compute_alpha { /** * compute.targetPools.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.targetPools.testIamPermissions * @memberOf! () * @@ -75716,6 +76517,10 @@ export namespace compute_alpha { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ @@ -75982,7 +76787,7 @@ export namespace compute_alpha { /** * compute.targetSslProxies.delete - * @desc Deletes the specified TargetSslProxy resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified TargetSslProxy resource. * @alias compute.targetSslProxies.delete * @memberOf! () * @@ -76058,7 +76863,7 @@ export namespace compute_alpha { /** * compute.targetSslProxies.get - * @desc Returns the specified TargetSslProxy resource. Gets a list of available target SSL proxies by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified TargetSslProxy resource. Gets a list of available target SSL proxies by making a list() request. * @alias compute.targetSslProxies.get * @memberOf! () * @@ -76133,7 +76938,7 @@ export namespace compute_alpha { /** * compute.targetSslProxies.insert - * @desc Creates a TargetSslProxy resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a TargetSslProxy resource in the specified project using the data included in the request. * @alias compute.targetSslProxies.insert * @memberOf! () * @@ -76209,7 +77014,7 @@ export namespace compute_alpha { /** * compute.targetSslProxies.list - * @desc Retrieves the list of TargetSslProxy resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of TargetSslProxy resources available to the specified project. * @alias compute.targetSslProxies.list * @memberOf! () * @@ -76287,7 +77092,7 @@ export namespace compute_alpha { /** * compute.targetSslProxies.setBackendService - * @desc Changes the BackendService for TargetSslProxy. (== suppress_warning http-rest-shadowed ==) + * @desc Changes the BackendService for TargetSslProxy. * @alias compute.targetSslProxies.setBackendService * @memberOf! () * @@ -76364,7 +77169,7 @@ export namespace compute_alpha { /** * compute.targetSslProxies.setProxyHeader - * @desc Changes the ProxyHeaderType for TargetSslProxy. (== suppress_warning http-rest-shadowed ==) + * @desc Changes the ProxyHeaderType for TargetSslProxy. * @alias compute.targetSslProxies.setProxyHeader * @memberOf! () * @@ -76441,7 +77246,7 @@ export namespace compute_alpha { /** * compute.targetSslProxies.setSslCertificates - * @desc Changes SslCertificates for TargetSslProxy. (== suppress_warning http-rest-shadowed ==) + * @desc Changes SslCertificates for TargetSslProxy. * @alias compute.targetSslProxies.setSslCertificates * @memberOf! () * @@ -76518,7 +77323,7 @@ export namespace compute_alpha { /** * compute.targetSslProxies.setSslPolicy - * @desc Sets the SSL policy for TargetSslProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the SSL proxy load balancer. They do not affect the connection between the load balancer and the backends. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the SSL policy for TargetSslProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the SSL proxy load balancer. They do not affect the connection between the load balancer and the backends. * @alias compute.targetSslProxies.setSslPolicy * @memberOf! () * @@ -76595,7 +77400,7 @@ export namespace compute_alpha { /** * compute.targetSslProxies.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.targetSslProxies.testIamPermissions * @memberOf! () * @@ -76889,7 +77694,7 @@ export namespace compute_alpha { /** * compute.targetTcpProxies.delete - * @desc Deletes the specified TargetTcpProxy resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified TargetTcpProxy resource. * @alias compute.targetTcpProxies.delete * @memberOf! () * @@ -76965,7 +77770,7 @@ export namespace compute_alpha { /** * compute.targetTcpProxies.get - * @desc Returns the specified TargetTcpProxy resource. Gets a list of available target TCP proxies by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified TargetTcpProxy resource. Gets a list of available target TCP proxies by making a list() request. * @alias compute.targetTcpProxies.get * @memberOf! () * @@ -77040,7 +77845,7 @@ export namespace compute_alpha { /** * compute.targetTcpProxies.insert - * @desc Creates a TargetTcpProxy resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a TargetTcpProxy resource in the specified project using the data included in the request. * @alias compute.targetTcpProxies.insert * @memberOf! () * @@ -77116,7 +77921,7 @@ export namespace compute_alpha { /** * compute.targetTcpProxies.list - * @desc Retrieves the list of TargetTcpProxy resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of TargetTcpProxy resources available to the specified project. * @alias compute.targetTcpProxies.list * @memberOf! () * @@ -77194,7 +77999,7 @@ export namespace compute_alpha { /** * compute.targetTcpProxies.setBackendService - * @desc Changes the BackendService for TargetTcpProxy. (== suppress_warning http-rest-shadowed ==) + * @desc Changes the BackendService for TargetTcpProxy. * @alias compute.targetTcpProxies.setBackendService * @memberOf! () * @@ -77271,7 +78076,7 @@ export namespace compute_alpha { /** * compute.targetTcpProxies.setProxyHeader - * @desc Changes the ProxyHeaderType for TargetTcpProxy. (== suppress_warning http-rest-shadowed ==) + * @desc Changes the ProxyHeaderType for TargetTcpProxy. * @alias compute.targetTcpProxies.setProxyHeader * @memberOf! () * @@ -77348,7 +78153,7 @@ export namespace compute_alpha { /** * compute.targetTcpProxies.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.targetTcpProxies.testIamPermissions * @memberOf! () * @@ -77592,12 +78397,13 @@ export namespace compute_alpha { /** * compute.targetVpnGateways.aggregatedList - * @desc Retrieves an aggregated list of target VPN gateways. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of target VPN gateways. * @alias compute.targetVpnGateways.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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. @@ -77679,7 +78485,7 @@ export namespace compute_alpha { /** * compute.targetVpnGateways.delete - * @desc Deletes the specified target VPN gateway. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified target VPN gateway. * @alias compute.targetVpnGateways.delete * @memberOf! () * @@ -77756,7 +78562,7 @@ export namespace compute_alpha { /** * compute.targetVpnGateways.get - * @desc Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request. * @alias compute.targetVpnGateways.get * @memberOf! () * @@ -77832,7 +78638,7 @@ export namespace compute_alpha { /** * compute.targetVpnGateways.insert - * @desc Creates a target VPN gateway in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a target VPN gateway in the specified project and region using the data included in the request. * @alias compute.targetVpnGateways.insert * @memberOf! () * @@ -77909,7 +78715,7 @@ export namespace compute_alpha { /** * compute.targetVpnGateways.list - * @desc Retrieves a list of target VPN gateways available to the specified project and region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of target VPN gateways available to the specified project and region. * @alias compute.targetVpnGateways.list * @memberOf! () * @@ -77990,7 +78796,7 @@ export namespace compute_alpha { /** * compute.targetVpnGateways.setLabels - * @desc Sets the labels on a TargetVpnGateway. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the labels on a TargetVpnGateway. To learn more about labels, read the Labeling Resources documentation. * @alias compute.targetVpnGateways.setLabels * @memberOf! () * @@ -78068,7 +78874,7 @@ export namespace compute_alpha { /** * compute.targetVpnGateways.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.targetVpnGateways.testIamPermissions * @memberOf! () * @@ -78159,6 +78965,10 @@ export namespace compute_alpha { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ @@ -78340,12 +79150,13 @@ export namespace compute_alpha { /** * compute.urlMaps.aggregatedList - * @desc Retrieves the list of all UrlMap resources, regional and global, available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of all UrlMap resources, regional and global, available to the specified project. * @alias compute.urlMaps.aggregatedList * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. @@ -78421,7 +79232,7 @@ export namespace compute_alpha { /** * compute.urlMaps.delete - * @desc Deletes the specified UrlMap resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified UrlMap resource. * @alias compute.urlMaps.delete * @memberOf! () * @@ -78496,7 +79307,7 @@ export namespace compute_alpha { /** * compute.urlMaps.get - * @desc Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request. * @alias compute.urlMaps.get * @memberOf! () * @@ -78568,7 +79379,7 @@ export namespace compute_alpha { /** * compute.urlMaps.insert - * @desc Creates a UrlMap resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a UrlMap resource in the specified project using the data included in the request. * @alias compute.urlMaps.insert * @memberOf! () * @@ -78642,7 +79453,7 @@ export namespace compute_alpha { /** * compute.urlMaps.invalidateCache - * @desc Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. (== suppress_warning http-rest-shadowed ==) + * @desc Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. * @alias compute.urlMaps.invalidateCache * @memberOf! () * @@ -78719,7 +79530,7 @@ export namespace compute_alpha { /** * compute.urlMaps.list - * @desc Retrieves the list of UrlMap resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of UrlMap resources available to the specified project. * @alias compute.urlMaps.list * @memberOf! () * @@ -78795,7 +79606,7 @@ export namespace compute_alpha { /** * compute.urlMaps.patch - * @desc Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.urlMaps.patch * @memberOf! () * @@ -78871,7 +79682,7 @@ export namespace compute_alpha { /** * compute.urlMaps.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.urlMaps.testIamPermissions * @memberOf! () * @@ -78951,7 +79762,7 @@ export namespace compute_alpha { /** * compute.urlMaps.update - * @desc Updates the specified UrlMap resource with the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified UrlMap resource with the data included in the request. * @alias compute.urlMaps.update * @memberOf! () * @@ -79027,7 +79838,7 @@ export namespace compute_alpha { /** * compute.urlMaps.validate - * @desc Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap. (== suppress_warning http-rest-shadowed ==) + * @desc Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap. * @alias compute.urlMaps.validate * @memberOf! () * @@ -79116,6 +79927,10 @@ export namespace compute_alpha { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ @@ -79337,12 +80152,13 @@ export namespace compute_alpha { /** * compute.vpnGateways.aggregatedList - * @desc Retrieves an aggregated list of VPN gateways. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of VPN gateways. * @alias compute.vpnGateways.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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. @@ -79419,7 +80235,7 @@ export namespace compute_alpha { /** * compute.vpnGateways.delete - * @desc Deletes the specified VPN gateway. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified VPN gateway. * @alias compute.vpnGateways.delete * @memberOf! () * @@ -79496,7 +80312,7 @@ export namespace compute_alpha { /** * compute.vpnGateways.get - * @desc Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request. * @alias compute.vpnGateways.get * @memberOf! () * @@ -79571,7 +80387,7 @@ export namespace compute_alpha { /** * compute.vpnGateways.getStatus - * @desc Returns the status for the specified VPN gateway. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the status for the specified VPN gateway. * @alias compute.vpnGateways.getStatus * @memberOf! () * @@ -79656,7 +80472,7 @@ export namespace compute_alpha { /** * compute.vpnGateways.insert - * @desc Creates a VPN gateway in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a VPN gateway in the specified project and region using the data included in the request. * @alias compute.vpnGateways.insert * @memberOf! () * @@ -79733,7 +80549,7 @@ export namespace compute_alpha { /** * compute.vpnGateways.list - * @desc Retrieves a list of VPN gateways available to the specified project and region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of VPN gateways available to the specified project and region. * @alias compute.vpnGateways.list * @memberOf! () * @@ -79811,7 +80627,7 @@ export namespace compute_alpha { /** * compute.vpnGateways.setLabels - * @desc Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation. * @alias compute.vpnGateways.setLabels * @memberOf! () * @@ -79889,7 +80705,7 @@ export namespace compute_alpha { /** * compute.vpnGateways.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.vpnGateways.testIamPermissions * @memberOf! () * @@ -79980,6 +80796,10 @@ export namespace compute_alpha { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ @@ -80179,12 +80999,13 @@ export namespace compute_alpha { /** * compute.vpnTunnels.aggregatedList - * @desc Retrieves an aggregated list of VPN tunnels. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of VPN tunnels. * @alias compute.vpnTunnels.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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. @@ -80261,7 +81082,7 @@ export namespace compute_alpha { /** * compute.vpnTunnels.delete - * @desc Deletes the specified VpnTunnel resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified VpnTunnel resource. * @alias compute.vpnTunnels.delete * @memberOf! () * @@ -80338,7 +81159,7 @@ export namespace compute_alpha { /** * compute.vpnTunnels.get - * @desc Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request. * @alias compute.vpnTunnels.get * @memberOf! () * @@ -80413,7 +81234,7 @@ export namespace compute_alpha { /** * compute.vpnTunnels.insert - * @desc Creates a VpnTunnel resource in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a VpnTunnel resource in the specified project and region using the data included in the request. * @alias compute.vpnTunnels.insert * @memberOf! () * @@ -80490,7 +81311,7 @@ export namespace compute_alpha { /** * compute.vpnTunnels.list - * @desc Retrieves a list of VpnTunnel resources contained in the specified project and region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of VpnTunnel resources contained in the specified project and region. * @alias compute.vpnTunnels.list * @memberOf! () * @@ -80568,7 +81389,7 @@ export namespace compute_alpha { /** * compute.vpnTunnels.setLabels - * @desc Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources documentation. * @alias compute.vpnTunnels.setLabels * @memberOf! () * @@ -80646,7 +81467,7 @@ export namespace compute_alpha { /** * compute.vpnTunnels.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.vpnTunnels.testIamPermissions * @memberOf! () * @@ -80737,6 +81558,10 @@ export namespace compute_alpha { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) */ @@ -80916,7 +81741,7 @@ export namespace compute_alpha { /** * compute.zoneOperations.delete - * @desc Deletes the specified zone-specific Operations resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified zone-specific Operations resource. * @alias compute.zoneOperations.delete * @memberOf! () * @@ -80990,7 +81815,7 @@ export namespace compute_alpha { /** * compute.zoneOperations.get - * @desc Retrieves the specified zone-specific Operations resource. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the specified zone-specific Operations resource. * @alias compute.zoneOperations.get * @memberOf! () * @@ -81066,7 +81891,7 @@ export namespace compute_alpha { /** * compute.zoneOperations.list - * @desc Retrieves a list of Operation resources contained within the specified zone. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of Operation resources contained within the specified zone. * @alias compute.zoneOperations.list * @memberOf! () * @@ -81145,7 +81970,7 @@ export namespace compute_alpha { /** * compute.zoneOperations.wait - * @desc Waits for the specified zone-specific Operations resource until it is done or timeout, and retrieves the specified Operations resource. 1. Immediately returns when the operation is already done. 2. Waits for no more than the default deadline (2 minutes, subject to change) and then returns the current state of the operation, which may be DONE or still in progress. 3. Is best-effort: a. The server can wait less than the default deadline or zero seconds, in overload situations. b. There is no guarantee that the operation is actually done when returns. 4. User should be prepared to retry if the operation is not DONE. (== suppress_warning http-rest-shadowed ==) + * @desc Waits for the specified zone-specific Operations resource until it is done or timeout, and retrieves the specified Operations resource. 1. Immediately returns when the operation is already done. 2. Waits for no more than the default deadline (2 minutes, subject to change) and then returns the current state of the operation, which may be DONE or still in progress. 3. Is best-effort: a. The server can wait less than the default deadline or zero seconds, in overload situations. b. There is no guarantee that the operation is actually done when returns. 4. User should be prepared to retry if the operation is not DONE. * @alias compute.zoneOperations.wait * @memberOf! () * @@ -81321,7 +82146,7 @@ export namespace compute_alpha { /** * compute.zones.get - * @desc Returns the specified Zone resource. Gets a list of available zones by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified Zone resource. Gets a list of available zones by making a list() request. * @alias compute.zones.get * @memberOf! () * @@ -81392,7 +82217,7 @@ export namespace compute_alpha { /** * compute.zones.list - * @desc Retrieves the list of Zone resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of Zone resources available to the specified project. * @alias compute.zones.list * @memberOf! () * diff --git a/src/apis/compute/beta.ts b/src/apis/compute/beta.ts index 203f4e17921..be5e6144bab 100644 --- a/src/apis/compute/beta.ts +++ b/src/apis/compute/beta.ts @@ -113,6 +113,7 @@ export namespace compute_beta { interconnects: Resource$Interconnects; licenseCodes: Resource$Licensecodes; licenses: Resource$Licenses; + machineImages: Resource$Machineimages; machineTypes: Resource$Machinetypes; networkEndpointGroups: Resource$Networkendpointgroups; networks: Resource$Networks; @@ -197,6 +198,7 @@ export namespace compute_beta { this.interconnects = new Resource$Interconnects(this.context); this.licenseCodes = new Resource$Licensecodes(this.context); this.licenses = new Resource$Licenses(this.context); + this.machineImages = new Resource$Machineimages(this.context); this.machineTypes = new Resource$Machinetypes(this.context); this.networkEndpointGroups = new Resource$Networkendpointgroups( this.context @@ -710,7 +712,7 @@ export namespace compute_beta { */ diskName?: string | null; /** - * Specifies the size of the disk in base-2 GB. If not specified, the disk will be the same size as the image (usually 10GB). If specified, the size must be equal to or larger than 10GB. + * Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB. */ diskSizeGb?: string | null; /** @@ -824,7 +826,7 @@ export namespace compute_beta { */ selfLink?: string | null; /** - * [Output Only] The status of the autoscaler configuration. Current set of possible values: PENDING: Autoscaler backend hasn't read new/updated configuration DELETING: Configuration is being deleted ACTIVE: Configuration is acknowledged to be effective. Some warnings might or might not be present in the status_details field. ERROR: Configuration has errors. Actionable for users. Details are present in the status_details field. New values might be added in the future. + * [Output Only] The status of the autoscaler configuration. Current set of possible values: - PENDING: Autoscaler backend hasn't read new/updated configuration. - DELETING: Configuration is being deleted. - ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field. - ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future. */ status?: string | null; /** @@ -923,7 +925,7 @@ export namespace compute_beta { */ message?: string | null; /** - * The type of error, warning or notice returned. Current set of possible values: ALL_INSTANCES_UNHEALTHY (WARNING): All instances in the instance group are unhealthy (not in RUNNING state). BACKEND_SERVICE_DOES_NOT_EXIST (ERROR): There is no backend service attached to the instance group. CAPPED_AT_MAX_NUM_REPLICAS (WARNING): Autoscaler recommends size bigger than maxNumReplicas. CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE (WARNING): The custom metric samples are not exported often enough to be a credible base for autoscaling. CUSTOM_METRIC_INVALID (ERROR): The custom metric that was specified does not exist or does not have the necessary labels. MIN_EQUALS_MAX (WARNING): The minNumReplicas is equal to maxNumReplicas. This means the autoscaler cannot add or remove instances from the instance group. MISSING_CUSTOM_METRIC_DATA_POINTS (WARNING): The autoscaler did not receive any data from the custom metric configured for autoscaling. MISSING_LOAD_BALANCING_DATA_POINTS (WARNING): The autoscaler is configured to scale based on a load balancing signal but the instance group has not received any requests from the load balancer. MODE_OFF (WARNING): Autoscaling is turned off. The number of instances in the group won't change automatically. The autoscaling configuration is preserved. MODE_ONLY_UP (WARNING): Autoscaling is in the "Autoscale only up" mode. Instances in the group will be only added. MORE_THAN_ONE_BACKEND_SERVICE (ERROR): The instance group cannot be autoscaled because it has more than one backend service attached to it. NOT_ENOUGH_QUOTA_AVAILABLE (ERROR): Exceeded quota for necessary resources, such as CPU, number of instances and so on. REGION_RESOURCE_STOCKOUT (ERROR): Showed only for regional autoscalers: there is a resource stockout in the chosen region. SCALING_TARGET_DOES_NOT_EXIST (ERROR): The target to be scaled does not exist. UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION (ERROR): Autoscaling does not work with an HTTP/S load balancer that has been configured for maxRate. ZONE_RESOURCE_STOCKOUT (ERROR): For zonal autoscalers: there is a resource stockout in the chosen zone. For regional autoscalers: in at least one of the zones you're using there is a resource stockout. New values might be added in the future. Some of the values might not be available in all API versions. + * The type of error, warning, or notice returned. Current set of possible values: - ALL_INSTANCES_UNHEALTHY (WARNING): All instances in the instance group are unhealthy (not in RUNNING state). - BACKEND_SERVICE_DOES_NOT_EXIST (ERROR): There is no backend service attached to the instance group. - CAPPED_AT_MAX_NUM_REPLICAS (WARNING): Autoscaler recommends a size greater than maxNumReplicas. - CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE (WARNING): The custom metric samples are not exported often enough to be a credible base for autoscaling. - CUSTOM_METRIC_INVALID (ERROR): The custom metric that was specified does not exist or does not have the necessary labels. - MIN_EQUALS_MAX (WARNING): The minNumReplicas is equal to maxNumReplicas. This means the autoscaler cannot add or remove instances from the instance group. - MISSING_CUSTOM_METRIC_DATA_POINTS (WARNING): The autoscaler did not receive any data from the custom metric configured for autoscaling. - MISSING_LOAD_BALANCING_DATA_POINTS (WARNING): The autoscaler is configured to scale based on a load balancing signal but the instance group has not received any requests from the load balancer. - MODE_OFF (WARNING): Autoscaling is turned off. The number of instances in the group won't change automatically. The autoscaling configuration is preserved. - MODE_ONLY_UP (WARNING): Autoscaling is in the "Autoscale only up" mode. The autoscaler can add instances but not remove any. - MORE_THAN_ONE_BACKEND_SERVICE (ERROR): The instance group cannot be autoscaled because it has more than one backend service attached to it. - NOT_ENOUGH_QUOTA_AVAILABLE (ERROR): There is insufficient quota for the necessary resources, such as CPU or number of instances. - REGION_RESOURCE_STOCKOUT (ERROR): Shown only for regional autoscalers: there is a resource stockout in the chosen region. - SCALING_TARGET_DOES_NOT_EXIST (ERROR): The target to be scaled does not exist. - UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION (ERROR): Autoscaling does not work with an HTTP/S load balancer that has been configured for maxRate. - ZONE_RESOURCE_STOCKOUT (ERROR): For zonal autoscalers: there is a resource stockout in the chosen zone. For regional autoscalers: in at least one of the zones you're using there is a resource stockout. New values might be added in the future. Some of the values might not be available in all API versions. */ type?: string | null; } @@ -1210,7 +1212,7 @@ export namespace compute_beta { */ loadBalancingScheme?: string | null; /** - * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. + * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. If sessionAffinity is not NONE, and this field is not set to >MAGLEV or RING_HASH, session affinity settings will not take effect. */ localityLbPolicy?: string | null; /** @@ -1254,7 +1256,7 @@ export namespace compute_beta { */ selfLink?: string | null; /** - * Type of session affinity to use. The default is NONE. Session affinity is not applicable if the --protocol is UDP. When the loadBalancingScheme is EXTERNAL, possible values are NONE, CLIENT_IP, or GENERATED_COOKIE. You can use GENERATED_COOKIE if the protocol is HTTP or HTTPS. When the loadBalancingScheme is INTERNAL, possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. When the loadBalancingScheme is INTERNAL_SELF_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE. + * Type of session affinity to use. The default is NONE. Session affinity is not applicable if the --protocol is UDP. When the loadBalancingScheme is EXTERNAL, possible values are NONE, CLIENT_IP, or GENERATED_COOKIE. You can use GENERATED_COOKIE if the protocol is HTTP or HTTPS. When the loadBalancingScheme is INTERNAL, possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. When the loadBalancingScheme is INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE. */ sessionAffinity?: string | null; /** @@ -1549,7 +1551,7 @@ export namespace compute_beta { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example,`alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -1874,7 +1876,7 @@ export namespace compute_beta { */ kmsKeyName?: string | null; /** - * The service account being used for the encryption request for the given KMS key. If absent, default GCE compute robot account will be used + * The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. */ kmsKeyServiceAccount?: string | null; /** @@ -1941,6 +1943,10 @@ export namespace compute_beta { * Encrypts the disk using a customer-supplied encryption key. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. */ diskEncryptionKey?: Schema$CustomerEncryptionKey; + /** + * Specifies whether the disk restored from a source snapshot should erase Windows specific VSS signature. + */ + eraseWindowsVssSignature?: boolean | null; /** * A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. */ @@ -2686,7 +2692,7 @@ export namespace compute_beta { */ IPAddress?: string | null; /** - * The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP. For Internal TCP/UDP Load Balancing, the load balancing scheme is INTERNAL, and one of TCP or UDP are valid. For Traffic Director, the load balancing scheme is INTERNAL_SELF_MANAGED, and only TCPis valid. For Internal HTTP(S) Load Balancing, the load balancing scheme is INTERNAL_MANAGED, and only TCP is valid. For HTTP(S), SSL Proxy, and TCP Proxy Load Balancing, the load balancing scheme is EXTERNAL and only TCP is valid. For Network TCP/UDP Load Balancing, the load balancing scheme is EXTERNAL, and one of TCP or UDP is valid. + * The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP or ICMP. For Internal TCP/UDP Load Balancing, the load balancing scheme is INTERNAL, and one of TCP or UDP are valid. For Traffic Director, the load balancing scheme is INTERNAL_SELF_MANAGED, and only TCPis valid. For Internal HTTP(S) Load Balancing, the load balancing scheme is INTERNAL_MANAGED, and only TCP is valid. For HTTP(S), SSL Proxy, and TCP Proxy Load Balancing, the load balancing scheme is EXTERNAL and only TCP is valid. For Network TCP/UDP Load Balancing, the load balancing scheme is EXTERNAL, and one of TCP or UDP is valid. */ IPProtocol?: string | null; /** @@ -2714,7 +2720,7 @@ export namespace compute_beta { */ loadBalancingScheme?: string | null; /** - * Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. metadataFilters specified here can be overridden by those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. + * Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule will not be visible to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. metadataFilters specified here will be applifed before those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. */ metadataFilters?: Schema$MetadataFilter[]; /** @@ -2730,11 +2736,11 @@ export namespace compute_beta { */ networkTier?: string | null; /** - * This field is deprecated. See the port field. + * When the load balancing scheme is EXTERNAL, INTERNAL_SELF_MANAGED and INTERNAL_MANAGED, you can specify a port_range. Use with a forwarding rule that points to a target proxy or a target pool. Do not use with a forwarding rule that points to a backend service. This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges. Some types of forwarding target have constraints on the acceptable ports: - TargetHttpProxy: 80, 8080 - TargetHttpsProxy: 443 - TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 - TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 - TargetVpnGateway: 500, 4500 */ portRange?: string | null; /** - * List of comma-separated ports. The forwarding rule forwards packets with matching destination ports. If the forwarding rule's loadBalancingScheme is EXTERNAL, and the forwarding rule references a target pool, specifying ports is optional. You can specify an unlimited number of ports, but they must be contiguous. If you omit ports, GCP forwards traffic on any port of the forwarding rule's protocol. If the forwarding rule's loadBalancingScheme is EXTERNAL, and the forwarding rule references a target HTTP proxy, target HTTPS proxy, target TCP proxy, target SSL proxy, or target VPN gateway, you must specify ports using the following constraints: - TargetHttpProxy: 80, 8080 - TargetHttpsProxy: 443 - TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 - TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 - TargetVpnGateway: 500, 4500 If the forwarding rule's loadBalancingScheme is INTERNAL, you must specify ports in one of the following ways: * A list of up to five ports, which can be non-contiguous * Keyword ALL, which causes the forwarding rule to forward traffic on any port of the forwarding rule's protocol. The ports field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. Applicable only when IPProtocol is TCP, UDP, or SCTP. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges. + * This field is used along with the backend_service field for internal load balancing. When the load balancing scheme is INTERNAL, a list of ports can be configured, for example, ['80'], ['8000','9000']. Only packets addressed to these ports are forwarded to the backends configured with the forwarding rule. If the forwarding rule's loadBalancingScheme is INTERNAL, you can specify ports in one of the following ways: * A list of up to five ports, which can be non-contiguous * Keyword ALL, which causes the forwarding rule to forward traffic on any port of the forwarding rule's protocol. */ ports?: string[] | null; /** @@ -2875,7 +2881,7 @@ export namespace compute_beta { */ kind?: string | null; /** - * The path to be queried. This can be the default namespace ('/') or a nested namespace ('//') or a specified key ('//') + * The path to be queried. This can be the default namespace ('/') or a nested namespace ('/\/') or a specified key ('/\/\') */ queryPath?: string | null; /** @@ -3232,7 +3238,7 @@ export namespace compute_beta { */ prefixMatch?: string | null; /** - * A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value or not. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. + * A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. */ presentMatch?: boolean | null; /** @@ -3390,7 +3396,7 @@ export namespace compute_beta { */ export interface Schema$HttpQueryParameterMatch { /** - * The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch and regexMatch must be set. + * The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch or regexMatch must be set. */ exactMatch?: string | null; /** @@ -3398,11 +3404,11 @@ export namespace compute_beta { */ name?: string | null; /** - * Specifies that the queryParameterMatch matches if the request contains the query parameter, irrespective of whether the parameter has a value or not. Only one of presentMatch, exactMatch and regexMatch must be set. + * Specifies that the queryParameterMatch matches if the request contains the query parameter, irrespective of whether the parameter has a value or not. Only one of presentMatch, exactMatch or regexMatch must be set. */ presentMatch?: boolean | null; /** - * The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch, exactMatch and regexMatch must be set. + * The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch, exactMatch or regexMatch must be set. */ regexMatch?: string | null; } @@ -3474,7 +3480,7 @@ export namespace compute_beta { */ timeout?: Schema$Duration; /** - * The spec to modify the URL of the request, prior to forwarding the request to the matched service + * The spec to modify the URL of the request, prior to forwarding the request to the matched service. */ urlRewrite?: Schema$UrlRewrite; /** @@ -3500,7 +3506,7 @@ export namespace compute_beta { */ priority?: number | null; /** - * In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. + * In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. */ routeAction?: Schema$HttpRouteAction; /** @@ -3517,7 +3523,7 @@ export namespace compute_beta { */ export interface Schema$HttpRouteRuleMatch { /** - * For satifying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL. FullPathMatch must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified. + * For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL. fullPathMatch must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified. */ fullPathMatch?: string | null; /** @@ -3525,15 +3531,15 @@ export namespace compute_beta { */ headerMatches?: Schema$HttpHeaderMatch[]; /** - * Specifies that prefixMatch and fullPathMatch matches are case sensitive. The default value is false. caseSensitive must not be used with regexMatch. + * Specifies that prefixMatch and fullPathMatch matches are case sensitive. The default value is false. ignoreCase must not be used with regexMatch. */ ignoreCase?: boolean | null; /** - * Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. metadataFilters specified here can be overrides those specified in ForwardingRule that refers to this UrlMap. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. + * Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. */ metadataFilters?: Schema$MetadataFilter[]; /** - * For satifying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. The value must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified. + * For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. The value must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified. */ prefixMatch?: string | null; /** @@ -3541,7 +3547,7 @@ export namespace compute_beta { */ queryParameterMatches?: Schema$HttpQueryParameterMatch[]; /** - * For satifying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript Only one of prefixMatch, fullPathMatch or regexMatch must be specified. + * For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript Only one of prefixMatch, fullPathMatch or regexMatch must be specified. */ regexMatch?: string | null; } @@ -3855,6 +3861,10 @@ export namespace compute_beta { * Enables display device for the instance. */ displayDevice?: Schema$DisplayDevice; + /** + * Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature. + */ + eraseWindowsVssSignature?: boolean | null; /** * A list of the type and count of accelerator cards attached to the instance. */ @@ -3919,6 +3929,14 @@ export namespace compute_beta { shieldedInstanceIntegrityPolicy?: Schema$ShieldedInstanceIntegrityPolicy; shieldedVmConfig?: Schema$ShieldedVmConfig; shieldedVmIntegrityPolicy?: Schema$ShieldedVmIntegrityPolicy; + /** + * Source machine image + */ + sourceMachineImage?: string | null; + /** + * Source GMI encryption key when creating an instance from GMI. + */ + sourceMachineImageEncryptionKey?: Schema$CustomerEncryptionKey; /** * [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity. */ @@ -3971,7 +3989,7 @@ export namespace compute_beta { } | null; } /** - * Represents an unmanaged Instance Group resource. Use unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. For more information, read Instance groups. For zonal unmanaged Instance Group, use instanceGroups resource. For regional unmanaged Instance Group, use regionInstanceGroups resource. (== resource_for beta.instanceGroups ==) (== resource_for v1.instanceGroups ==) (== resource_for beta.regionInstanceGroups ==) (== resource_for v1.regionInstanceGroups ==) + * Represents an Instance Group resource. Instance Groups can be used to configure a target for load balancing. Instance groups can either be managed or unmanaged. To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead. Use zonal unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. You cannot create regional unmanaged instance groups. For more information, read Instance groups. (== resource_for beta.instanceGroups ==) (== resource_for v1.instanceGroups ==) (== resource_for beta.regionInstanceGroups ==) (== resource_for v1.regionInstanceGroups ==) */ export interface Schema$InstanceGroup { /** @@ -4166,6 +4184,10 @@ export namespace compute_beta { * The service account to be used as credentials for all operations performed by the managed instance group on instances. The service accounts needs all permissions required to create and delete instances. By default, the service account {projectNumber}@cloudservices.gserviceaccount.com is used. */ serviceAccount?: string | null; + /** + * Stateful configuration for this Instanced Group Manager + */ + statefulPolicy?: Schema$StatefulPolicy; /** * [Output Only] The status of this managed instance group. */ @@ -4358,6 +4380,25 @@ export namespace compute_beta { */ instances?: string[] | null; } + /** + * InstanceGroupManagers.deletePerInstanceConfigs + */ + export interface Schema$InstanceGroupManagersDeletePerInstanceConfigsReq { + /** + * The list of instance names for which we want to delete per-instance configs on this managed instance group. + */ + names?: string[] | null; + } + export interface Schema$InstanceGroupManagersListErrorsResponse { + /** + * [Output Only] The list of errors of the managed instance group. + */ + items?: Schema$InstanceManagedByIgmError[]; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + } export interface Schema$InstanceGroupManagersListManagedInstancesResponse { /** * [Output Only] The list of instances in the managed instance group. @@ -4368,6 +4409,33 @@ export namespace compute_beta { */ nextPageToken?: string | null; } + export interface Schema$InstanceGroupManagersListPerInstanceConfigsResp { + /** + * [Output Only] The list of PerInstanceConfig. + */ + items?: Schema$PerInstanceConfig[]; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * InstanceGroupManagers.patchPerInstanceConfigs + */ + export interface Schema$InstanceGroupManagersPatchPerInstanceConfigsReq { + /** + * The list of per-instance configs to insert or patch on this managed instance group. + */ + perInstanceConfigs?: Schema$PerInstanceConfig[]; + } export interface Schema$InstanceGroupManagersRecreateInstancesRequest { /** * The URLs of one or more instances to recreate. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. @@ -4422,17 +4490,36 @@ export namespace compute_beta { * [Output Only] A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified. */ isStable?: boolean | null; + /** + * [Output Only] Stateful status of the given Instance Group Manager. + */ + stateful?: Schema$InstanceGroupManagerStatusStateful; /** * [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager. */ versionTarget?: Schema$InstanceGroupManagerStatusVersionTarget; } + export interface Schema$InstanceGroupManagerStatusStateful { + /** + * [Output Only] A bit indicating whether the managed instance group is stateful, i.e. has any disks in Stateful Policy or at least one per-instance config. This is determined based on the user intent, the group may be reported as not stateful even when there is still some preserved state on managed instances. + */ + isStateful?: boolean | null; + } export interface Schema$InstanceGroupManagerStatusVersionTarget { /** * [Output Only] A bit indicating whether version target has been reached in this managed instance group, i.e. all instances are in their target version. Instances' target version are specified by version field on Instance Group Manager. */ isReached?: boolean | null; } + /** + * InstanceGroupManagers.updatePerInstanceConfigs + */ + export interface Schema$InstanceGroupManagersUpdatePerInstanceConfigsReq { + /** + * The list of per-instance configs to insert or patch on this managed instance group. + */ + perInstanceConfigs?: Schema$PerInstanceConfig[]; + } export interface Schema$InstanceGroupManagerUpdatePolicy { /** * The instance redistribution policy for regional managed instance groups. Valid values are: - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region. - NONE: For non-autoscaled groups, proactive redistribution is disabled. @@ -4454,6 +4541,10 @@ export namespace compute_beta { * Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600]. */ minReadySec?: number | null; + /** + * What action should be used to replace instances. See minimal_action.REPLACE + */ + replacementMethod?: string | null; /** * The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls). */ @@ -4611,6 +4702,44 @@ export namespace compute_beta { message?: string; } | null; } + export interface Schema$InstanceManagedByIgmError { + /** + * [Output Only] Contents of the error. + */ + error?: Schema$InstanceManagedByIgmErrorManagedInstanceError; + /** + * [Output Only] Details of the instance action that triggered this error. May be null, if the error was not caused by an action on an instance. This field is optional. + */ + instanceActionDetails?: Schema$InstanceManagedByIgmErrorInstanceActionDetails; + /** + * [Output Only] The time that this error occurred. This value is in RFC3339 text format. + */ + timestamp?: string | null; + } + export interface Schema$InstanceManagedByIgmErrorInstanceActionDetails { + /** + * [Output Only] Action that managed instance group was executing on the instance when the error occurred. Possible values: + */ + action?: string | null; + /** + * [Output Only] The URL of the instance. The URL can be set even if the instance has not yet been created. + */ + instance?: string | null; + /** + * [Output Only] Version this instance was created from, or was being created from, but the creation failed. Corresponds to one of the versions that were set on the Instance Group Manager resource at the time this instance was being created. + */ + version?: Schema$ManagedInstanceVersion; + } + export interface Schema$InstanceManagedByIgmErrorManagedInstanceError { + /** + * [Output Only] Error code. + */ + code?: string | null; + /** + * [Output Only] Error message. + */ + message?: string | null; + } export interface Schema$InstanceMoveRequest { /** * The URL of the destination zone to move the instance. This can be a full or partial URL. For example, the following are all valid URLs to a zone: - https://www.googleapis.com/compute/v1/projects/project/zones/zone - projects/project/zones/zone - zones/zone @@ -4666,6 +4795,10 @@ export namespace compute_beta { * Specifies the reservations that this instance can consume from. */ reservationAffinity?: Schema$ReservationAffinity; + /** + * Resource policies (names, not ULRs) applied to instances created from this templae. + */ + resourcePolicies?: string[] | null; /** * Specifies the scheduling options for the instances that are created from this template. */ @@ -5649,6 +5782,100 @@ export namespace compute_beta { */ logMode?: string | null; } + /** + * Machine image resource. + */ + export interface Schema$MachineImage { + /** + * [Output Only] The creation timestamp for this machine image in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * [Input Only] Specifies to create an application consistent machine image by informing the OS to prepare for the snapshot process. Currently only supported on Windows instances using the Volume Shadow Copy Service (VSS). + */ + guestFlush?: boolean | null; + /** + * [Output Only] A unique identifier for this machine image. The server defines this identifier. + */ + id?: string | null; + /** + * [Output Only] The resource type, which is always compute#machineImage for machine image. + */ + kind?: string | null; + /** + * Encrypts the machine image using a customer-supplied encryption key. After you encrypt a machine image using a customer-supplied key, you must provide the same key if you use the machine image later. For example, you must provide the encryption key when you create an instance from the encrypted machine image in a future request. Customer-supplied encryption keys do not protect access to metadata of the machine image. If you do not provide an encryption key when creating the machine image, then the machine image will be encrypted using an automatically generated key and you do not need to provide a key to use the machine image later. + */ + machineImageEncryptionKey?: Schema$CustomerEncryptionKey; + /** + * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * [Output Only] The URL for this machine image. The server defines this URL. + */ + selfLink?: string | null; + /** + * [Input Only] The customer-supplied encryption key of the disks attached to the source instance. Required if the source disk is protected by a customer-supplied encryption key. + */ + sourceDiskEncryptionKeys?: Schema$SourceDiskEncryptionKey[]; + /** + * The source instance used to create the machine image. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance - projects/project/zones/zone/instances/instance + */ + sourceInstance?: string | null; + /** + * [Output Only] Properties of source instance. + */ + sourceInstanceProperties?: Schema$SourceInstanceProperties; + /** + * [Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING. + */ + status?: string | null; + /** + * GCS bucket storage location of the machine image (regional or multi-regional). + */ + storageLocations?: string[] | null; + /** + * [Output Only] Total size of the storage used by the machine image. + */ + totalStorageBytes?: string | null; + } + /** + * A list of machine images. + */ + export interface Schema$MachineImageList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of MachineImage resources. + */ + items?: Schema$MachineImage[]; + /** + * [Output Only] The resource type, which is always compute#machineImagesListResponse for machine image lists. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } /** * Represents a Machine Type resource. You can use specific machine types for your VM instances based on performance and pricing requirements. For more information, read Machine Types. (== resource_for v1.machineTypes ==) (== resource_for beta.machineTypes ==) */ @@ -5811,6 +6038,14 @@ export namespace compute_beta { * [Output Only] Information about the last attempt to create or delete the instance. */ lastAttempt?: Schema$ManagedInstanceLastAttempt; + /** + * [Output Only] Preserved state applied from per-instance config for this instance. + */ + preservedStateFromConfig?: Schema$PreservedState; + /** + * [Output Only] Preserved state generated based on stateful policy for this instance. + */ + preservedStateFromPolicy?: Schema$PreservedState; /** * [Output Only] Intended version of this instance. */ @@ -5862,7 +6097,7 @@ export namespace compute_beta { kind?: string | null; } /** - * Opaque filter criteria used by loadbalancers to restrict routing configuration to a limited set of loadbalancing proxies. Proxies and sidecars involved in loadbalancing would typically present metadata to the loadbalancers which need to match criteria specified here. If a match takes place, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. An example for using metadataFilters would be: if loadbalancing involves Envoys, they will only receive routing configuration when values in metadataFilters match values supplied in <a href="https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/core/base.proto#envoy-api-msg-core-node" Node metadata of their XDS requests to loadbalancers. + * Opaque filter criteria used by loadbalancers to restrict routing configuration to a limited set of loadbalancing proxies. Proxies and sidecars involved in loadbalancing would typically present metadata to the loadbalancers which need to match criteria specified here. If a match takes place, the relevant configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. An example for using metadataFilters would be: if loadbalancing involves Envoys, they will only receive routing configuration when values in metadataFilters match values supplied in <a href="https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/core/base.proto#envoy-api-msg-core-node" Node metadata of their XDS requests to loadbalancers. */ export interface Schema$MetadataFilter { /** @@ -5933,7 +6168,7 @@ export namespace compute_beta { */ kind?: string | null; /** - * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. */ name?: string | null; /** @@ -5954,7 +6189,7 @@ export namespace compute_beta { subnetworks?: string[] | null; } /** - * The network endpoint. + * The network endpoint. Next ID: 7 */ export interface Schema$NetworkEndpoint { /** @@ -5971,7 +6206,7 @@ export namespace compute_beta { port?: number | null; } /** - * Represents a collection of network endpoints. For more information read Setting up network endpoint groups in load balancing. (== resource_for v1.networkEndpointGroups ==) (== resource_for beta.networkEndpointGroups ==) + * Represents a collection of network endpoints. For more information read Setting up network endpoint groups in load balancing. (== resource_for v1.networkEndpointGroups ==) (== resource_for beta.networkEndpointGroups ==) Next ID: 21 */ export interface Schema$NetworkEndpointGroup { /** @@ -6192,6 +6427,10 @@ export namespace compute_beta { * Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface, otherwise the request will fail with error 412 conditionNotMet. */ fingerprint?: string | null; + /** + * [Output Only] An IPv6 internal network address for this network interface. + */ + ipv6Address?: string | null; /** * [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. */ @@ -6320,9 +6559,13 @@ export namespace compute_beta { networkPeering?: Schema$NetworkPeering; } /** - * Represent a sole-tenant Node Group resource. A sole-tenant node is a physical server that is dedicated to hosting VM instances only for your specific project. Use sole-tenant nodes to keep your instances physically separated from instances in other projects, or to group your instances together on the same host hardware. For more information, read Sole-tenant nodes. (== resource_for beta.nodeGroups ==) (== resource_for v1.nodeGroups ==) NextID: 16 + * Represent a sole-tenant Node Group resource. A sole-tenant node is a physical server that is dedicated to hosting VM instances only for your specific project. Use sole-tenant nodes to keep your instances physically separated from instances in other projects, or to group your instances together on the same host hardware. For more information, read Sole-tenant nodes. (== resource_for beta.nodeGroups ==) (== resource_for v1.nodeGroups ==) */ export interface Schema$NodeGroup { + /** + * Specifies how autoscaling should behave. + */ + autoscalingPolicy?: Schema$NodeGroupAutoscalingPolicy; /** * [Output Only] Creation timestamp in RFC3339 text format. */ @@ -6331,6 +6574,7 @@ export namespace compute_beta { * An optional description of this resource. Provide this property when you create the resource. */ description?: string | null; + fingerprint?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ @@ -6339,6 +6583,10 @@ export namespace compute_beta { * [Output Only] The type of the resource. Always compute#nodeGroup for node group. */ kind?: string | null; + /** + * Specifies how to handle instances when a node in the group undergoes maintenance. + */ + maintenancePolicy?: string | null; /** * 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. */ @@ -6391,6 +6639,20 @@ export namespace compute_beta { message?: string; } | null; } + export interface Schema$NodeGroupAutoscalingPolicy { + /** + * The maximum number of nodes that the group should have. + */ + maxNodes?: number | null; + /** + * The minimum number of nodes that the group should have. + */ + minNodes?: number | null; + /** + * The autoscaling mode. + */ + mode?: string | null; + } /** * Contains a list of nodeGroups. */ @@ -6441,6 +6703,10 @@ export namespace compute_beta { * Binding properties for the physical server. */ serverBinding?: Schema$ServerBinding; + /** + * Server ID associated with this node. + */ + serverId?: string | null; status?: string | null; } export interface Schema$NodeGroupsAddNodesRequest { @@ -6506,7 +6772,7 @@ export namespace compute_beta { nodeTemplate?: string | null; } /** - * Represent a sole-tenant Node Template resource. You can use a template to define properties for nodes in a node group. For more information, read Creating node groups and instances. (== resource_for beta.nodeTemplates ==) (== resource_for v1.nodeTemplates ==) (== NextID: 16 ==) + * Represent a sole-tenant Node Template resource. You can use a template to define properties for nodes in a node group. For more information, read Creating node groups and instances. (== resource_for beta.nodeTemplates ==) (== resource_for v1.nodeTemplates ==) */ export interface Schema$NodeTemplate { /** @@ -6983,7 +7249,7 @@ export namespace compute_beta { */ enforcingSuccessRate?: number | null; /** - * Time interval between ejection sweep analysis. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 seconds. + * Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second. */ interval?: Schema$Duration; /** @@ -7246,7 +7512,7 @@ export namespace compute_beta { */ defaultService?: string | null; /** - * When when none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. + * When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. */ defaultUrlRedirect?: Schema$HttpRedirectAction; /** @@ -7266,7 +7532,7 @@ export namespace compute_beta { */ pathRules?: Schema$PathRule[]; /** - * The list of ordered HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. The order of specifying routeRules matters: the first rule that matches will cause its specified routing action to take effect. Within a given pathMatcher, only one of pathRules or routeRules must be set. routeRules are not supported in UrlMaps intended for External Load balancers. + * The list of HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number. Within a given pathMatcher, only one of pathRules or routeRules must be set. routeRules are not supported in UrlMaps intended for External Load balancers. */ routeRules?: Schema$HttpRouteRule[]; } @@ -7300,9 +7566,13 @@ export namespace compute_beta { * The name of the per-instance config and the corresponding instance. Serves as a merge key during UpdatePerInstanceConfigs operation, i.e. if per-instance config with the same name exists then it will be updated, otherwise a new one will be created for the VM instance with the same name. An attempt to create a per-instance config for a VM instance that either doesn't exist or is not part of the group will result in a failure. */ name?: string | null; + /** + * Intended preserved state for the given instance. Does not contain state generated based on Stateful Policy. + */ + preservedState?: Schema$PreservedState; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -7310,11 +7580,11 @@ export namespace compute_beta { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if either of incoming or stored policy does not meet the version requirements. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; iamOwned?: boolean | null; @@ -7323,7 +7593,7 @@ export namespace compute_beta { */ rules?: Schema$Rule[]; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a conditional binding from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, any version compliance checks on the incoming and/or stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } @@ -7333,6 +7603,33 @@ export namespace compute_beta { */ expressionSets?: Schema$WafExpressionSet[]; } + /** + * Preserved state for a given instance. + */ + export interface Schema$PreservedState { + /** + * Preserved disks defined for this instance. This map is keyed with the device names of the disks. + */ + disks?: {[key: string]: Schema$PreservedStatePreservedDisk} | null; + /** + * Preserved metadata defined for this instance. + */ + metadata?: {[key: string]: string} | null; + } + export interface Schema$PreservedStatePreservedDisk { + /** + * These stateful disks will never be deleted during autohealing, update, instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole MIG is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted. + */ + autoDelete?: string | null; + /** + * The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. + */ + mode?: string | null; + /** + * The URL of the disk resource that is stateful and should be attached to the VM instance. + */ + source?: string | null; + } /** * Represents a Project resource. A project is used to organize resources in a Google Cloud Platform environment. For more information, read about the Resource Hierarchy. (== resource_for v1.projects ==) (== resource_for beta.projects ==) */ @@ -7635,6 +7932,15 @@ export namespace compute_beta { message?: string; } | null; } + /** + * RegionInstanceGroupManagers.deletePerInstanceConfigs + */ + export interface Schema$RegionInstanceGroupManagerDeleteInstanceConfigReq { + /** + * The list of instance names for which we want to delete per-instance configs on this managed instance group. + */ + names?: string[] | null; + } /** * Contains a list of managed instance groups. */ @@ -7668,6 +7974,15 @@ export namespace compute_beta { message?: string; } | null; } + /** + * RegionInstanceGroupManagers.patchPerInstanceConfigs + */ + export interface Schema$RegionInstanceGroupManagerPatchInstanceConfigReq { + /** + * The list of per-instance configs to insert or patch on this managed instance group. + */ + perInstanceConfigs?: Schema$PerInstanceConfig[]; + } export interface Schema$RegionInstanceGroupManagersAbandonInstancesRequest { /** * The URLs of one or more instances to abandon. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. @@ -7706,6 +8021,34 @@ export namespace compute_beta { */ instances?: string[] | null; } + export interface Schema$RegionInstanceGroupManagersListErrorsResponse { + /** + * [Output Only] The list of errors of the managed instance group. + */ + items?: Schema$InstanceManagedByIgmError[]; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + } + export interface Schema$RegionInstanceGroupManagersListInstanceConfigsResp { + /** + * [Output Only] The list of PerInstanceConfig. + */ + items?: Schema$PerInstanceConfig[]; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } export interface Schema$RegionInstanceGroupManagersListInstancesResponse { /** * A list of managed instances. @@ -7741,6 +8084,15 @@ export namespace compute_beta { */ instanceTemplate?: string | null; } + /** + * RegionInstanceGroupManagers.updatePerInstanceConfigs + */ + export interface Schema$RegionInstanceGroupManagerUpdateInstanceConfigReq { + /** + * The list of per-instance configs to insert or patch on this managed instance group. + */ + perInstanceConfigs?: Schema$PerInstanceConfig[]; + } export interface Schema$RegionInstanceGroupsListInstances { /** * [Output Only] Unique identifier for the resource; defined by the server. @@ -8865,6 +9217,75 @@ export namespace compute_beta { */ permissions?: string[] | null; } + /** + * An instance-attached disk resource. + */ + export interface Schema$SavedAttachedDisk { + /** + * Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). + */ + autoDelete?: boolean | null; + /** + * Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. + */ + boot?: boolean | null; + /** + * Specifies the name of the disk attached to the source instance. + */ + deviceName?: string | null; + /** + * The encryption key for the disk. + */ + diskEncryptionKey?: Schema$CustomerEncryptionKey; + /** + * The size of the disk in base-2 GB. + */ + diskSizeGb?: string | null; + /** + * [Output Only] URL of the disk type resource. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd + */ + diskType?: string | null; + /** + * A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. + */ + guestOsFeatures?: Schema$GuestOsFeature[]; + /** + * Specifies zero-based index of the disk that is attached to the source instance. + */ + index?: number | null; + /** + * Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. + */ + interface?: string | null; + /** + * [Output Only] Type of the resource. Always compute#attachedDisk for attached disks. + */ + kind?: string | null; + /** + * [Output Only] Any valid publicly visible licenses. + */ + licenses?: string[] | null; + /** + * The mode in which this disk is attached to the source instance, either READ_WRITE or READ_ONLY. + */ + mode?: string | null; + /** + * Specifies a URL of the disk attached to the source instance. + */ + source?: string | null; + /** + * [Output Only] A size of the storage used by the disk's snapshot by this machine image. + */ + storageBytes?: string | null; + /** + * [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date. + */ + storageBytesStatus?: string | null; + /** + * Specifies the type of the attached disk, either SCRATCH or PERSISTENT. + */ + type?: string | null; + } /** * Sets the scheduling options for an Instance. NextID: 9 */ @@ -8873,6 +9294,10 @@ export namespace compute_beta { * Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. */ automaticRestart?: boolean | null; + /** + * The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. + */ + minNodeCpus?: number | null; /** * A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. */ @@ -9206,7 +9631,7 @@ export namespace compute_beta { */ export interface Schema$Snapshot { /** - * [Output Only] Set to true if snapshots are automatically by applying resource policy on the target disk. + * [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk. */ autoCreated?: boolean | null; /** @@ -9319,6 +9744,16 @@ export namespace compute_beta { message?: string; } | null; } + export interface Schema$SourceDiskEncryptionKey { + /** + * The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. + */ + diskEncryptionKey?: Schema$CustomerEncryptionKey; + /** + * URL of the disk attached to the source instance. This can be a full or valid partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk + */ + sourceDisk?: string | null; + } /** * A specification of the parameters to use when creating the instance template from a source instance. */ @@ -9328,8 +9763,62 @@ export namespace compute_beta { */ diskConfigs?: Schema$DiskInstantiationConfig[]; } + export interface Schema$SourceInstanceProperties { + /** + * Enables instances created based on this machine image to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information. + */ + canIpForward?: boolean | null; + /** + * Whether the instance created from this machine image should be protected against deletion. + */ + deletionProtection?: boolean | null; + /** + * An optional text description for the instances that are created from this machine image. + */ + description?: string | null; + /** + * An array of disks that are associated with the instances that are created from this machine image. + */ + disks?: Schema$SavedAttachedDisk[]; + /** + * A list of guest accelerator cards' type and count to use for instances created from this machine image. + */ + guestAccelerators?: Schema$AcceleratorConfig[]; + /** + * Labels to apply to instances that are created from this machine image. + */ + labels?: {[key: string]: string} | null; + /** + * The machine type to use for instances that are created from this machine image. + */ + machineType?: string | null; + /** + * The metadata key/value pairs to assign to instances that are created from this machine image. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information. + */ + metadata?: Schema$Metadata; + /** + * Minimum cpu/platform to be used by instances created from this machine image. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more information, read Specifying a Minimum CPU Platform. + */ + minCpuPlatform?: string | null; + /** + * An array of network access configurations for this interface. + */ + networkInterfaces?: Schema$NetworkInterface[]; + /** + * Specifies the scheduling options for the instances that are created from this machine image. + */ + scheduling?: Schema$Scheduling; + /** + * A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this machine image. Use metadata queries to obtain the access tokens for these instances. + */ + serviceAccounts?: Schema$ServiceAccount[]; + /** + * A list of tags to apply to the instances that are created from this machine image. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035. + */ + tags?: Schema$Tags; + } /** - * Represents an SSL Certificate resource. This SSL certificate resource also contains a private key. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and Using SSL Certificates. (== resource_for beta.sslCertificates ==) (== resource_for v1.sslCertificates ==) + * Represents an SSL Certificate resource. This SSL certificate resource also contains a private key. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and Using SSL Certificates. (== resource_for beta.sslCertificates ==) (== resource_for v1.sslCertificates ==) (== resource_for beta.regionSslCertificates ==) (== resource_for v1.regionSslCertificates ==) Next ID: 17 */ export interface Schema$SslCertificate { /** @@ -9618,6 +10107,26 @@ export namespace compute_beta { */ sslPolicy?: string | null; } + export interface Schema$StatefulPolicy { + preservedState?: Schema$StatefulPolicyPreservedState; + } + /** + * Configuration of preserved resources. + */ + export interface Schema$StatefulPolicyPreservedState { + /** + * Disks created on the instances that will be preserved on instance delete, update, etc. This map is keyed with the device names of the disks. + */ + disks?: { + [key: string]: Schema$StatefulPolicyPreservedStateDiskDevice; + } | null; + } + export interface Schema$StatefulPolicyPreservedStateDiskDevice { + /** + * These stateful disks will never be deleted during autohealing, update or VM instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted. + */ + autoDelete?: string | null; + } /** * Represents a Subnetwork resource. A subnetwork (also known as a subnet) is a logical partition of a Virtual Private Cloud network with one primary IP range and zero or more secondary IP ranges. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for beta.subnetworks ==) (== resource_for v1.subnetworks ==) */ @@ -9654,6 +10163,10 @@ export namespace compute_beta { * The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field can be set only at resource creation time. */ ipCidrRange?: string | null; + /** + * [Output Only] The range of internal IPv6 addresses that are owned by this subnetwork. + */ + ipv6CidrRange?: string | null; /** * [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. */ @@ -9674,6 +10187,14 @@ export namespace compute_beta { * Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess. */ privateIpGoogleAccess?: boolean | null; + /** + * The private IPv6 google access type for the VMs in this subnet. This is an expanded field of enablePrivateV6Access. If both fields are set, privateIpv6GoogleAccess will take priority. This field can be both set at resource creation time and updated using patch. + */ + privateIpv6GoogleAccess?: string | null; + /** + * The service accounts can be used to selectively turn on Private IPv6 Google Access only on the VMs primary service account matching the value. This value only takes effect when PrivateIpv6GoogleAccess is ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE_FOR_SERVICE_ACCOUNTS or ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE_FOR_SERVICE_ACCOUNTS. + */ + privateIpv6GoogleAccessServiceAccounts?: string[] | null; /** * The purpose of the resource. This field can be either PRIVATE_RFC_1918 or INTERNAL_HTTPS_LOAD_BALANCER. A subnetwork with purpose set to INTERNAL_HTTPS_LOAD_BALANCER is a user-created subnetwork that is reserved for Internal HTTP(S) Load Balancing. If unspecified, the purpose defaults to PRIVATE_RFC_1918. */ @@ -9847,7 +10368,7 @@ export namespace compute_beta { } | null; } /** - * Represents a Target HTTP Proxy resource. A target HTTP proxy is a component of certain types of load balancers. Global forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies. (== resource_for beta.targetHttpProxies ==) (== resource_for v1.targetHttpProxies ==) + * Represents a Target HTTP Proxy resource. A target HTTP proxy is a component of GCP HTTP load balancers. Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for beta.targetHttpProxies ==) (== resource_for v1.targetHttpProxies ==) (== resource_for beta.regionTargetHttpProxies ==) (== resource_for v1.regionTargetHttpProxies ==) */ export interface Schema$TargetHttpProxy { /** @@ -9973,7 +10494,7 @@ export namespace compute_beta { sslCertificates?: string[] | null; } /** - * Represents a Target HTTPS Proxy resource. A target HTTPS proxy is a component of certain types of load balancers. Global forwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies. (== resource_for beta.targetHttpsProxies ==) (== resource_for v1.targetHttpsProxies ==) + * Represents a Target HTTPS Proxy resource. A target HTTPS proxy is a component of GCP HTTPS load balancers. Forwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for beta.targetHttpsProxies ==) (== resource_for v1.targetHttpsProxies ==) (== resource_for beta.regionTargetHttpsProxies ==) (== resource_for v1.regionTargetHttpsProxies ==) */ export interface Schema$TargetHttpsProxy { /** @@ -11075,7 +11596,7 @@ export namespace compute_beta { } | null; } /** - * Represents a VPN gateway resource. + * Represents a VPN gateway resource. Next ID: 13 */ export interface Schema$VpnGateway { /** @@ -11642,7 +12163,7 @@ export namespace compute_beta { /** * compute.acceleratorTypes.aggregatedList - * @desc Retrieves an aggregated list of accelerator types. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of accelerator types. * @example * * // BEFORE RUNNING: * // --------------- @@ -11792,7 +12313,7 @@ export namespace compute_beta { /** * compute.acceleratorTypes.get - * @desc Returns the specified accelerator type. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified accelerator type. * @example * * // BEFORE RUNNING: * // --------------- @@ -11924,7 +12445,7 @@ export namespace compute_beta { /** * compute.acceleratorTypes.list - * @desc Retrieves a list of accelerator types available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of accelerator types available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -12157,7 +12678,7 @@ export namespace compute_beta { /** * compute.addresses.aggregatedList - * @desc Retrieves an aggregated list of addresses. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of addresses. * @example * * // BEFORE RUNNING: * // --------------- @@ -12301,7 +12822,7 @@ export namespace compute_beta { /** * compute.addresses.delete - * @desc Deletes the specified address resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified address resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -12433,7 +12954,7 @@ export namespace compute_beta { /** * compute.addresses.get - * @desc Returns the specified address resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified address resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -12562,7 +13083,7 @@ export namespace compute_beta { /** * compute.addresses.insert - * @desc Creates an address resource in the specified project by using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates an address resource in the specified project by using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -12695,7 +13216,7 @@ export namespace compute_beta { /** * compute.addresses.list - * @desc Retrieves a list of addresses contained within the specified region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of addresses contained within the specified region. * @example * * // BEFORE RUNNING: * // --------------- @@ -12839,7 +13360,7 @@ export namespace compute_beta { /** * compute.addresses.setLabels - * @desc Sets the labels on an Address. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the labels on an Address. To learn more about labels, read the Labeling Resources documentation. * @example * * // BEFORE RUNNING: * // --------------- @@ -12977,7 +13498,7 @@ export namespace compute_beta { /** * compute.addresses.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -13305,7 +13826,7 @@ export namespace compute_beta { /** * compute.autoscalers.aggregatedList - * @desc Retrieves an aggregated list of autoscalers. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of autoscalers. * @example * * // BEFORE RUNNING: * // --------------- @@ -13450,7 +13971,7 @@ export namespace compute_beta { /** * compute.autoscalers.delete - * @desc Deletes the specified autoscaler. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified autoscaler. * @example * * // BEFORE RUNNING: * // --------------- @@ -13583,7 +14104,7 @@ export namespace compute_beta { /** * compute.autoscalers.get - * @desc Returns the specified autoscaler resource. Gets a list of available autoscalers by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified autoscaler resource. Gets a list of available autoscalers by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -13714,7 +14235,7 @@ export namespace compute_beta { /** * compute.autoscalers.insert - * @desc Creates an autoscaler in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates an autoscaler in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -13848,7 +14369,7 @@ export namespace compute_beta { /** * compute.autoscalers.list - * @desc Retrieves a list of autoscalers contained within the specified zone. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of autoscalers contained within the specified zone. * @example * * // BEFORE RUNNING: * // --------------- @@ -13992,7 +14513,7 @@ export namespace compute_beta { /** * compute.autoscalers.patch - * @desc Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- @@ -14128,7 +14649,7 @@ export namespace compute_beta { /** * compute.autoscalers.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -14269,7 +14790,7 @@ export namespace compute_beta { /** * compute.autoscalers.update - * @desc Updates an autoscaler in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Updates an autoscaler in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -14623,7 +15144,7 @@ export namespace compute_beta { /** * compute.backendBuckets.addSignedUrlKey - * @desc Adds a key for validating requests with signed URLs for this backend bucket. (== suppress_warning http-rest-shadowed ==) + * @desc Adds a key for validating requests with signed URLs for this backend bucket. * @alias compute.backendBuckets.addSignedUrlKey * @memberOf! () * @@ -14700,7 +15221,7 @@ export namespace compute_beta { /** * compute.backendBuckets.delete - * @desc Deletes the specified BackendBucket resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified BackendBucket resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -14829,7 +15350,7 @@ export namespace compute_beta { /** * compute.backendBuckets.deleteSignedUrlKey - * @desc Deletes a key for validating requests with signed URLs for this backend bucket. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes a key for validating requests with signed URLs for this backend bucket. * @alias compute.backendBuckets.deleteSignedUrlKey * @memberOf! () * @@ -14906,7 +15427,7 @@ export namespace compute_beta { /** * compute.backendBuckets.get - * @desc Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -15034,7 +15555,7 @@ export namespace compute_beta { /** * compute.backendBuckets.insert - * @desc Creates a BackendBucket resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a BackendBucket resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -15163,7 +15684,7 @@ export namespace compute_beta { /** * compute.backendBuckets.list - * @desc Retrieves the list of BackendBucket resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of BackendBucket resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -15303,7 +15824,7 @@ export namespace compute_beta { /** * compute.backendBuckets.patch - * @desc Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- @@ -15438,7 +15959,7 @@ export namespace compute_beta { /** * compute.backendBuckets.update - * @desc Updates the specified BackendBucket resource with the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified BackendBucket resource with the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -15765,7 +16286,7 @@ export namespace compute_beta { /** * compute.backendServices.addSignedUrlKey - * @desc Adds a key for validating requests with signed URLs for this backend service. (== suppress_warning http-rest-shadowed ==) + * @desc Adds a key for validating requests with signed URLs for this backend service. * @alias compute.backendServices.addSignedUrlKey * @memberOf! () * @@ -15842,7 +16363,7 @@ export namespace compute_beta { /** * compute.backendServices.aggregatedList - * @desc Retrieves the list of all BackendService resources, regional and global, available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of all BackendService resources, regional and global, available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -15992,7 +16513,7 @@ export namespace compute_beta { /** * compute.backendServices.delete - * @desc Deletes the specified BackendService resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified BackendService resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -16121,7 +16642,7 @@ export namespace compute_beta { /** * compute.backendServices.deleteSignedUrlKey - * @desc Deletes a key for validating requests with signed URLs for this backend service. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes a key for validating requests with signed URLs for this backend service. * @alias compute.backendServices.deleteSignedUrlKey * @memberOf! () * @@ -16198,7 +16719,7 @@ export namespace compute_beta { /** * compute.backendServices.get - * @desc Returns the specified BackendService resource. Gets a list of available backend services. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified BackendService resource. Gets a list of available backend services. * @example * * // BEFORE RUNNING: * // --------------- @@ -16326,7 +16847,7 @@ export namespace compute_beta { /** * compute.backendServices.getHealth - * @desc Gets the most recent health check results for this BackendService. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the most recent health check results for this BackendService. * @example * * // BEFORE RUNNING: * // --------------- @@ -16465,7 +16986,7 @@ export namespace compute_beta { /** * compute.backendServices.insert - * @desc Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information. * @example * * // BEFORE RUNNING: * // --------------- @@ -16595,7 +17116,7 @@ export namespace compute_beta { /** * compute.backendServices.list - * @desc Retrieves the list of BackendService resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of BackendService resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -16736,7 +17257,7 @@ export namespace compute_beta { /** * compute.backendServices.patch - * @desc Patches the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Patches the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- @@ -16871,7 +17392,7 @@ export namespace compute_beta { /** * compute.backendServices.setSecurityPolicy - * @desc Sets the security policy for the specified backend service. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the security policy for the specified backend service. * @example * * // BEFORE RUNNING: * // --------------- @@ -17006,7 +17527,7 @@ export namespace compute_beta { /** * compute.backendServices.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -17143,7 +17664,7 @@ export namespace compute_beta { /** * compute.backendServices.update - * @desc Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. * @example * * // BEFORE RUNNING: * // --------------- @@ -17565,7 +18086,7 @@ export namespace compute_beta { /** * compute.disks.addResourcePolicies - * @desc Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation. (== suppress_warning http-rest-shadowed ==) + * @desc Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation. * @alias compute.disks.addResourcePolicies * @memberOf! () * @@ -17643,7 +18164,7 @@ export namespace compute_beta { /** * compute.disks.aggregatedList - * @desc Retrieves an aggregated list of persistent disks. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of persistent disks. * @example * * // BEFORE RUNNING: * // --------------- @@ -17785,7 +18306,7 @@ export namespace compute_beta { /** * compute.disks.createSnapshot - * @desc Creates a snapshot of a specified persistent disk. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a snapshot of a specified persistent disk. * @example * * // BEFORE RUNNING: * // --------------- @@ -17924,7 +18445,7 @@ export namespace compute_beta { /** * compute.disks.delete - * @desc Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. * @example * * // BEFORE RUNNING: * // --------------- @@ -18056,7 +18577,7 @@ export namespace compute_beta { /** * compute.disks.get - * @desc Returns a specified persistent disk. Gets a list of available persistent disks by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns a specified persistent disk. Gets a list of available persistent disks by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -18185,7 +18706,7 @@ export namespace compute_beta { /** * compute.disks.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.disks.getIamPolicy * @memberOf! () * @@ -18260,7 +18781,7 @@ export namespace compute_beta { /** * compute.disks.insert - * @desc Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property. * @example * * // BEFORE RUNNING: * // --------------- @@ -18393,7 +18914,7 @@ export namespace compute_beta { /** * compute.disks.list - * @desc Retrieves a list of persistent disks contained within the specified zone. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of persistent disks contained within the specified zone. * @example * * // BEFORE RUNNING: * // --------------- @@ -18534,7 +19055,7 @@ export namespace compute_beta { /** * compute.disks.removeResourcePolicies - * @desc Removes resource policies from a disk. (== suppress_warning http-rest-shadowed ==) + * @desc Removes resource policies from a disk. * @alias compute.disks.removeResourcePolicies * @memberOf! () * @@ -18614,7 +19135,7 @@ export namespace compute_beta { /** * compute.disks.resize - * @desc Resizes the specified persistent disk. You can only increase the size of the disk. (== suppress_warning http-rest-shadowed ==) + * @desc Resizes the specified persistent disk. You can only increase the size of the disk. * @example * * // BEFORE RUNNING: * // --------------- @@ -18751,7 +19272,7 @@ export namespace compute_beta { /** * compute.disks.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.disks.setIamPolicy * @memberOf! () * @@ -18826,7 +19347,7 @@ export namespace compute_beta { /** * compute.disks.setLabels - * @desc Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation. * @example * * // BEFORE RUNNING: * // --------------- @@ -18963,7 +19484,7 @@ export namespace compute_beta { /** * compute.disks.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -19462,7 +19983,7 @@ export namespace compute_beta { /** * compute.diskTypes.aggregatedList - * @desc Retrieves an aggregated list of disk types. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of disk types. * @example * * // BEFORE RUNNING: * // --------------- @@ -19606,7 +20127,7 @@ export namespace compute_beta { /** * compute.diskTypes.get - * @desc Returns the specified disk type. Gets a list of available disk types by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified disk type. Gets a list of available disk types by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -19735,7 +20256,7 @@ export namespace compute_beta { /** * compute.diskTypes.list - * @desc Retrieves a list of disk types available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of disk types available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -19965,7 +20486,7 @@ export namespace compute_beta { /** * compute.externalVpnGateways.delete - * @desc Deletes the specified externalVpnGateway. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified externalVpnGateway. * @alias compute.externalVpnGateways.delete * @memberOf! () * @@ -20041,7 +20562,7 @@ export namespace compute_beta { /** * compute.externalVpnGateways.get - * @desc Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request. * @alias compute.externalVpnGateways.get * @memberOf! () * @@ -20116,7 +20637,7 @@ export namespace compute_beta { /** * compute.externalVpnGateways.insert - * @desc Creates a ExternalVpnGateway in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a ExternalVpnGateway in the specified project using the data included in the request. * @alias compute.externalVpnGateways.insert * @memberOf! () * @@ -20192,7 +20713,7 @@ export namespace compute_beta { /** * compute.externalVpnGateways.list - * @desc Retrieves the list of ExternalVpnGateway available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of ExternalVpnGateway available to the specified project. * @alias compute.externalVpnGateways.list * @memberOf! () * @@ -20272,7 +20793,7 @@ export namespace compute_beta { /** * compute.externalVpnGateways.setLabels - * @desc Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation. * @alias compute.externalVpnGateways.setLabels * @memberOf! () * @@ -20348,7 +20869,7 @@ export namespace compute_beta { /** * compute.externalVpnGateways.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.externalVpnGateways.testIamPermissions * @memberOf! () * @@ -20563,7 +21084,7 @@ export namespace compute_beta { /** * compute.firewalls.delete - * @desc Deletes the specified firewall. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified firewall. * @example * * // BEFORE RUNNING: * // --------------- @@ -20691,7 +21212,7 @@ export namespace compute_beta { /** * compute.firewalls.get - * @desc Returns the specified firewall. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified firewall. * @example * * // BEFORE RUNNING: * // --------------- @@ -20816,7 +21337,7 @@ export namespace compute_beta { /** * compute.firewalls.insert - * @desc Creates a firewall rule in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a firewall rule in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -20944,7 +21465,7 @@ export namespace compute_beta { /** * compute.firewalls.list - * @desc Retrieves the list of firewall rules available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of firewall rules available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -21083,7 +21604,7 @@ export namespace compute_beta { /** * compute.firewalls.patch - * @desc Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- @@ -21217,7 +21738,7 @@ export namespace compute_beta { /** * compute.firewalls.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -21354,7 +21875,7 @@ export namespace compute_beta { /** * compute.firewalls.update - * @desc Updates the specified firewall rule with the data included in the request. Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified firewall rule with the data included in the request. Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead. * @example * * // BEFORE RUNNING: * // --------------- @@ -21646,7 +22167,7 @@ export namespace compute_beta { /** * compute.forwardingRules.aggregatedList - * @desc Retrieves an aggregated list of forwarding rules. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of forwarding rules. * @example * * // BEFORE RUNNING: * // --------------- @@ -21796,7 +22317,7 @@ export namespace compute_beta { /** * compute.forwardingRules.delete - * @desc Deletes the specified ForwardingRule resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified ForwardingRule resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -21929,7 +22450,7 @@ export namespace compute_beta { /** * compute.forwardingRules.get - * @desc Returns the specified ForwardingRule resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified ForwardingRule resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -22061,7 +22582,7 @@ export namespace compute_beta { /** * compute.forwardingRules.insert - * @desc Creates a ForwardingRule resource in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a ForwardingRule resource in the specified project and region using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -22195,7 +22716,7 @@ export namespace compute_beta { /** * compute.forwardingRules.list - * @desc Retrieves a list of ForwardingRule resources available to the specified project and region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of ForwardingRule resources available to the specified project and region. * @example * * // BEFORE RUNNING: * // --------------- @@ -22340,7 +22861,7 @@ export namespace compute_beta { /** * compute.forwardingRules.patch - * @desc Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field. * @alias compute.forwardingRules.patch * @memberOf! () * @@ -22418,7 +22939,7 @@ export namespace compute_beta { /** * compute.forwardingRules.setLabels - * @desc Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation. * @example * * // BEFORE RUNNING: * // --------------- @@ -22556,7 +23077,7 @@ export namespace compute_beta { /** * compute.forwardingRules.setTarget - * @desc Changes target URL for forwarding rule. The new target should be of the same type as the old target. (== suppress_warning http-rest-shadowed ==) + * @desc Changes target URL for forwarding rule. The new target should be of the same type as the old target. * @example * * // BEFORE RUNNING: * // --------------- @@ -22694,7 +23215,7 @@ export namespace compute_beta { /** * compute.forwardingRules.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -23084,7 +23605,7 @@ export namespace compute_beta { /** * compute.globalAddresses.delete - * @desc Deletes the specified address resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified address resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -23213,7 +23734,7 @@ export namespace compute_beta { /** * compute.globalAddresses.get - * @desc Returns the specified address resource. Gets a list of available addresses by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified address resource. Gets a list of available addresses by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -23339,7 +23860,7 @@ export namespace compute_beta { /** * compute.globalAddresses.insert - * @desc Creates an address resource in the specified project by using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates an address resource in the specified project by using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -23468,7 +23989,7 @@ export namespace compute_beta { /** * compute.globalAddresses.list - * @desc Retrieves a list of global addresses. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of global addresses. * @example * * // BEFORE RUNNING: * // --------------- @@ -23608,7 +24129,7 @@ export namespace compute_beta { /** * compute.globalAddresses.setLabels - * @desc Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation. * @example * * // BEFORE RUNNING: * // --------------- @@ -23741,7 +24262,7 @@ export namespace compute_beta { /** * compute.globalAddresses.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -24013,7 +24534,7 @@ export namespace compute_beta { /** * compute.globalForwardingRules.delete - * @desc Deletes the specified GlobalForwardingRule resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified GlobalForwardingRule resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -24142,7 +24663,7 @@ export namespace compute_beta { /** * compute.globalForwardingRules.get - * @desc Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -24270,7 +24791,7 @@ export namespace compute_beta { /** * compute.globalForwardingRules.insert - * @desc Creates a GlobalForwardingRule resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a GlobalForwardingRule resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -24400,7 +24921,7 @@ export namespace compute_beta { /** * compute.globalForwardingRules.list - * @desc Retrieves a list of GlobalForwardingRule resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of GlobalForwardingRule resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -24541,7 +25062,7 @@ export namespace compute_beta { /** * compute.globalForwardingRules.patch - * @desc Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field. * @alias compute.globalForwardingRules.patch * @memberOf! () * @@ -24618,7 +25139,7 @@ export namespace compute_beta { /** * compute.globalForwardingRules.setLabels - * @desc Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation. * @example * * // BEFORE RUNNING: * // --------------- @@ -24751,7 +25272,7 @@ export namespace compute_beta { /** * compute.globalForwardingRules.setTarget - * @desc Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target. (== suppress_warning http-rest-shadowed ==) + * @desc Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target. * @example * * // BEFORE RUNNING: * // --------------- @@ -24885,7 +25406,7 @@ export namespace compute_beta { /** * compute.globalForwardingRules.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -25207,7 +25728,7 @@ export namespace compute_beta { /** * compute.globalOperations.aggregatedList - * @desc Retrieves an aggregated list of all operations. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of all operations. * @example * * // BEFORE RUNNING: * // --------------- @@ -25351,7 +25872,7 @@ export namespace compute_beta { /** * compute.globalOperations.delete - * @desc Deletes the specified Operations resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified Operations resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -25474,7 +25995,7 @@ export namespace compute_beta { /** * compute.globalOperations.get - * @desc Retrieves the specified Operations resource. Gets a list of operations by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the specified Operations resource. Gets a list of operations by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -25602,7 +26123,7 @@ export namespace compute_beta { /** * compute.globalOperations.list - * @desc Retrieves a list of Operation resources contained within the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of Operation resources contained within the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -25739,6 +26260,81 @@ export namespace compute_beta { return createAPIRequest(parameters); } } + + /** + * compute.globalOperations.wait + * @desc Waits for the specified Operations resource until it is done or timeout, and retrieves the specified Operations resource. 1. Immediately returns when the operation is already done. 2. Waits for no more than the default deadline (2 minutes, subject to change) and then returns the current state of the operation, which may be DONE or still in progress. 3. Is best-effort: a. The server can wait less than the default deadline or zero seconds, in overload situations. b. There is no guarantee that the operation is actually done when returns. 4. User should be prepared to retry if the operation is not DONE. + * @alias compute.globalOperations.wait + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.operation Name of the Operations resource to return. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + wait( + params?: Params$Resource$Globaloperations$Wait, + options?: MethodOptions + ): GaxiosPromise; + wait( + params: Params$Resource$Globaloperations$Wait, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Globaloperations$Wait, + callback: BodyResponseCallback + ): void; + wait(callback: BodyResponseCallback): void; + wait( + paramsOrCallback?: + | Params$Resource$Globaloperations$Wait + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globaloperations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globaloperations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/global/operations/{operation}/wait' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'operation'], + pathParams: ['operation', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Globaloperations$Aggregatedlist @@ -25829,6 +26425,22 @@ export namespace compute_beta { */ project?: string; } + export interface Params$Resource$Globaloperations$Wait + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the Operations resource to return. + */ + operation?: string; + /** + * Project ID for this request. + */ + project?: string; + } export class Resource$Healthchecks { context: APIRequestContext; @@ -25838,7 +26450,7 @@ export namespace compute_beta { /** * compute.healthChecks.aggregatedList - * @desc Retrieves the list of all HealthCheck resources, regional and global, available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of all HealthCheck resources, regional and global, available to the specified project. * @alias compute.healthChecks.aggregatedList * @memberOf! () * @@ -25923,7 +26535,7 @@ export namespace compute_beta { /** * compute.healthChecks.delete - * @desc Deletes the specified HealthCheck resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified HealthCheck resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -26052,7 +26664,7 @@ export namespace compute_beta { /** * compute.healthChecks.get - * @desc Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -26179,7 +26791,7 @@ export namespace compute_beta { /** * compute.healthChecks.insert - * @desc Creates a HealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a HealthCheck resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -26308,7 +26920,7 @@ export namespace compute_beta { /** * compute.healthChecks.list - * @desc Retrieves the list of HealthCheck resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of HealthCheck resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -26448,7 +27060,7 @@ export namespace compute_beta { /** * compute.healthChecks.patch - * @desc Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- @@ -26583,7 +27195,7 @@ export namespace compute_beta { /** * compute.healthChecks.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -26720,7 +27332,7 @@ export namespace compute_beta { /** * compute.healthChecks.update - * @desc Updates a HealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -27046,7 +27658,7 @@ export namespace compute_beta { /** * compute.httpHealthChecks.delete - * @desc Deletes the specified HttpHealthCheck resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified HttpHealthCheck resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -27175,7 +27787,7 @@ export namespace compute_beta { /** * compute.httpHealthChecks.get - * @desc Returns the specified HttpHealthCheck resource. Gets a list of available HTTP health checks by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified HttpHealthCheck resource. Gets a list of available HTTP health checks by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -27303,7 +27915,7 @@ export namespace compute_beta { /** * compute.httpHealthChecks.insert - * @desc Creates a HttpHealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a HttpHealthCheck resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -27433,7 +28045,7 @@ export namespace compute_beta { /** * compute.httpHealthChecks.list - * @desc Retrieves the list of HttpHealthCheck resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of HttpHealthCheck resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -27574,7 +28186,7 @@ export namespace compute_beta { /** * compute.httpHealthChecks.patch - * @desc Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- @@ -27709,7 +28321,7 @@ export namespace compute_beta { /** * compute.httpHealthChecks.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -27846,7 +28458,7 @@ export namespace compute_beta { /** * compute.httpHealthChecks.update - * @desc Updates a HttpHealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Updates a HttpHealthCheck resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -28145,7 +28757,7 @@ export namespace compute_beta { /** * compute.httpsHealthChecks.delete - * @desc Deletes the specified HttpsHealthCheck resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified HttpsHealthCheck resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -28274,7 +28886,7 @@ export namespace compute_beta { /** * compute.httpsHealthChecks.get - * @desc Returns the specified HttpsHealthCheck resource. Gets a list of available HTTPS health checks by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified HttpsHealthCheck resource. Gets a list of available HTTPS health checks by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -28402,7 +29014,7 @@ export namespace compute_beta { /** * compute.httpsHealthChecks.insert - * @desc Creates a HttpsHealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a HttpsHealthCheck resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -28532,7 +29144,7 @@ export namespace compute_beta { /** * compute.httpsHealthChecks.list - * @desc Retrieves the list of HttpsHealthCheck resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of HttpsHealthCheck resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -28675,7 +29287,7 @@ export namespace compute_beta { /** * compute.httpsHealthChecks.patch - * @desc Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- @@ -28810,7 +29422,7 @@ export namespace compute_beta { /** * compute.httpsHealthChecks.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -28947,7 +29559,7 @@ export namespace compute_beta { /** * compute.httpsHealthChecks.update - * @desc Updates a HttpsHealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Updates a HttpsHealthCheck resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -29246,7 +29858,7 @@ export namespace compute_beta { /** * compute.images.delete - * @desc Deletes the specified image. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified image. * @example * * // BEFORE RUNNING: * // --------------- @@ -29373,7 +29985,7 @@ export namespace compute_beta { /** * compute.images.deprecate - * @desc Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead. * @example * * // BEFORE RUNNING: * // --------------- @@ -29506,7 +30118,7 @@ export namespace compute_beta { /** * compute.images.get - * @desc Returns the specified image. Gets a list of available images by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified image. Gets a list of available images by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -29630,7 +30242,7 @@ export namespace compute_beta { /** * compute.images.getFromFamily - * @desc Returns the latest image that is part of an image family and is not deprecated. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the latest image that is part of an image family and is not deprecated. * @example * * // BEFORE RUNNING: * // --------------- @@ -29756,7 +30368,7 @@ export namespace compute_beta { /** * compute.images.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.images.getIamPolicy * @memberOf! () * @@ -29830,7 +30442,7 @@ export namespace compute_beta { /** * compute.images.insert - * @desc Creates an image in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates an image in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -29959,7 +30571,7 @@ export namespace compute_beta { /** * compute.images.list - * @desc Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. * @example * * // BEFORE RUNNING: * // --------------- @@ -30098,7 +30710,7 @@ export namespace compute_beta { /** * compute.images.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.images.setIamPolicy * @memberOf! () * @@ -30172,7 +30784,7 @@ export namespace compute_beta { /** * compute.images.setLabels - * @desc Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation. * @example * * // BEFORE RUNNING: * // --------------- @@ -30304,7 +30916,7 @@ export namespace compute_beta { /** * compute.images.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -30656,7 +31268,7 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.abandonInstances - * @desc Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. (== suppress_warning http-rest-shadowed ==) + * @desc Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @example * * // BEFORE RUNNING: * // --------------- @@ -30794,7 +31406,7 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.aggregatedList - * @desc Retrieves the list of managed instance groups and groups them by zone. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of managed instance groups and groups them by zone. * @example * * // BEFORE RUNNING: * // --------------- @@ -30944,7 +31556,7 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.applyUpdatesToInstances - * @desc Apply changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions. (== suppress_warning http-rest-shadowed ==) + * @desc Apply changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions. * @alias compute.instanceGroupManagers.applyUpdatesToInstances * @memberOf! () * @@ -31023,7 +31635,7 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.createInstances - * @desc Creates instances with per-instance configs in this managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method. (== suppress_warning http-rest-shadowed ==) + * @desc Creates instances with per-instance configs in this managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method. * @alias compute.instanceGroupManagers.createInstances * @memberOf! () * @@ -31101,7 +31713,7 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.delete - * @desc Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information. * @example * * // BEFORE RUNNING: * // --------------- @@ -31234,7 +31846,7 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.deleteInstances - * @desc Flags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. (== suppress_warning http-rest-shadowed ==) + * @desc Flags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @example * * // BEFORE RUNNING: * // --------------- @@ -31370,9 +31982,88 @@ export namespace compute_beta { } } + /** + * compute.instanceGroupManagers.deletePerInstanceConfigs + * @desc Deletes selected per-instance configs for the managed instance group. + * @alias compute.instanceGroupManagers.deletePerInstanceConfigs + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroupManager The name of the managed instance group. It should conform to RFC1035. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone where the managed instance group is located. It should conform to RFC1035. + * @param {().InstanceGroupManagersDeletePerInstanceConfigsReq} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + deletePerInstanceConfigs( + params?: Params$Resource$Instancegroupmanagers$Deleteperinstanceconfigs, + options?: MethodOptions + ): GaxiosPromise; + deletePerInstanceConfigs( + params: Params$Resource$Instancegroupmanagers$Deleteperinstanceconfigs, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deletePerInstanceConfigs( + params: Params$Resource$Instancegroupmanagers$Deleteperinstanceconfigs, + callback: BodyResponseCallback + ): void; + deletePerInstanceConfigs( + callback: BodyResponseCallback + ): void; + deletePerInstanceConfigs( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagers$Deleteperinstanceconfigs + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagers$Deleteperinstanceconfigs; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroupmanagers$Deleteperinstanceconfigs; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * compute.instanceGroupManagers.get - * @desc Returns all of the details about the specified managed instance group. Gets a list of available managed instance groups by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns all of the details about the specified managed instance group. Gets a list of available managed instance groups by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -31506,7 +32197,7 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.insert - * @desc Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit. * @example * * // BEFORE RUNNING: * // --------------- @@ -31640,7 +32331,7 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.list - * @desc Retrieves a list of managed instance groups that are contained within the specified project and zone. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of managed instance groups that are contained within the specified project and zone. * @example * * // BEFORE RUNNING: * // --------------- @@ -31785,9 +32476,106 @@ export namespace compute_beta { } } + /** + * compute.instanceGroupManagers.listErrors + * @desc Lists all errors thrown by actions on instances for a given managed instance group. + * @alias compute.instanceGroupManagers.listErrors + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {string} params.instanceGroupManager The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)|[1-9][0-9]{0,19}. + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone where the managed instance group is located. It should conform to RFC1035. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + listErrors( + params?: Params$Resource$Instancegroupmanagers$Listerrors, + options?: MethodOptions + ): GaxiosPromise; + listErrors( + params: Params$Resource$Instancegroupmanagers$Listerrors, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback< + Schema$InstanceGroupManagersListErrorsResponse + > + ): void; + listErrors( + params: Params$Resource$Instancegroupmanagers$Listerrors, + callback: BodyResponseCallback< + Schema$InstanceGroupManagersListErrorsResponse + > + ): void; + listErrors( + callback: BodyResponseCallback< + Schema$InstanceGroupManagersListErrorsResponse + > + ): void; + listErrors( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagers$Listerrors + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$InstanceGroupManagersListErrorsResponse + > + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagers$Listerrors; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroupmanagers$Listerrors; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listErrors' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * compute.instanceGroupManagers.listManagedInstances - * @desc Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. (== suppress_warning http-rest-shadowed ==) + * @desc Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. * @example * * // BEFORE RUNNING: * // --------------- @@ -31958,9 +32746,113 @@ export namespace compute_beta { } } + /** + * compute.instanceGroupManagers.listPerInstanceConfigs + * @desc Lists all of the per-instance configs defined for the managed instance group. + * @alias compute.instanceGroupManagers.listPerInstanceConfigs + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {string} params.instanceGroupManager The name of the managed instance group. It should conform to RFC1035. + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone where the managed instance group is located. It should conform to RFC1035. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + listPerInstanceConfigs( + params?: Params$Resource$Instancegroupmanagers$Listperinstanceconfigs, + options?: MethodOptions + ): GaxiosPromise; + listPerInstanceConfigs( + params: Params$Resource$Instancegroupmanagers$Listperinstanceconfigs, + options: + | MethodOptions + | BodyResponseCallback< + Schema$InstanceGroupManagersListPerInstanceConfigsResp + >, + callback: BodyResponseCallback< + Schema$InstanceGroupManagersListPerInstanceConfigsResp + > + ): void; + listPerInstanceConfigs( + params: Params$Resource$Instancegroupmanagers$Listperinstanceconfigs, + callback: BodyResponseCallback< + Schema$InstanceGroupManagersListPerInstanceConfigsResp + > + ): void; + listPerInstanceConfigs( + callback: BodyResponseCallback< + Schema$InstanceGroupManagersListPerInstanceConfigsResp + > + ): void; + listPerInstanceConfigs( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagers$Listperinstanceconfigs + | BodyResponseCallback< + Schema$InstanceGroupManagersListPerInstanceConfigsResp + >, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback< + Schema$InstanceGroupManagersListPerInstanceConfigsResp + >, + callback?: BodyResponseCallback< + Schema$InstanceGroupManagersListPerInstanceConfigsResp + > + ): void | GaxiosPromise< + Schema$InstanceGroupManagersListPerInstanceConfigsResp + > { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagers$Listperinstanceconfigs; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroupmanagers$Listperinstanceconfigs; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest< + Schema$InstanceGroupManagersListPerInstanceConfigsResp + >(parameters, callback); + } else { + return createAPIRequest< + Schema$InstanceGroupManagersListPerInstanceConfigsResp + >(parameters); + } + } + /** * compute.instanceGroupManagers.patch - * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- @@ -32097,9 +32989,89 @@ export namespace compute_beta { } } + /** + * compute.instanceGroupManagers.patchPerInstanceConfigs + * @desc Insert or patch (for the ones that already exist) per-instance configs for the managed instance group. perInstanceConfig.instance serves as a key used to distinguish whether to perform insert or patch. + * @alias compute.instanceGroupManagers.patchPerInstanceConfigs + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroupManager The name of the managed instance group. It should conform to RFC1035. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone where the managed instance group is located. It should conform to RFC1035. + * @param {().InstanceGroupManagersPatchPerInstanceConfigsReq} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patchPerInstanceConfigs( + params?: Params$Resource$Instancegroupmanagers$Patchperinstanceconfigs, + options?: MethodOptions + ): GaxiosPromise; + patchPerInstanceConfigs( + params: Params$Resource$Instancegroupmanagers$Patchperinstanceconfigs, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patchPerInstanceConfigs( + params: Params$Resource$Instancegroupmanagers$Patchperinstanceconfigs, + callback: BodyResponseCallback + ): void; + patchPerInstanceConfigs( + callback: BodyResponseCallback + ): void; + patchPerInstanceConfigs( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagers$Patchperinstanceconfigs + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagers$Patchperinstanceconfigs; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroupmanagers$Patchperinstanceconfigs; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * compute.instanceGroupManagers.recreateInstances - * @desc Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. (== suppress_warning http-rest-shadowed ==) + * @desc Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @example * * // BEFORE RUNNING: * // --------------- @@ -32237,7 +33209,7 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.resize - * @desc Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including: + The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. (== suppress_warning http-rest-shadowed ==) + * @desc Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including: + The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. * @example * * // BEFORE RUNNING: * // --------------- @@ -32376,7 +33348,7 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.resizeAdvanced - * @desc Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method. If you increase the size of the instance group, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating, creatingWithoutRetries, or deleting actions with the get or listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. (== suppress_warning http-rest-shadowed ==) + * @desc Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method. If you increase the size of the instance group, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating, creatingWithoutRetries, or deleting actions with the get or listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. * @example * * // BEFORE RUNNING: * // --------------- @@ -32514,7 +33486,7 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.setAutoHealingPolicies - * @desc Modifies the autohealing policies. [Deprecated] This method is deprecated. Please use Patch instead. (== suppress_warning http-rest-shadowed ==) + * @desc Modifies the autohealing policies. [Deprecated] This method is deprecated. Please use Patch instead. * @example * * // BEFORE RUNNING: * // --------------- @@ -32654,7 +33626,7 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.setInstanceTemplate - * @desc Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them. (== suppress_warning http-rest-shadowed ==) + * @desc Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them. * @example * * // BEFORE RUNNING: * // --------------- @@ -32792,7 +33764,7 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.setTargetPools - * @desc Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group. (== suppress_warning http-rest-shadowed ==) + * @desc Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group. * @example * * // BEFORE RUNNING: * // --------------- @@ -32930,7 +33902,7 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -33071,7 +34043,7 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.update - * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listManagedInstances method. (== suppress_warning http-rest-shadowed ==) + * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listManagedInstances method. * @example * * // BEFORE RUNNING: * // --------------- @@ -33207,6 +34179,86 @@ export namespace compute_beta { return createAPIRequest(parameters); } } + + /** + * compute.instanceGroupManagers.updatePerInstanceConfigs + * @desc Insert or update (for the ones that already exist) per-instance configs for the managed instance group. perInstanceConfig.instance serves as a key used to distinguish whether to perform insert or patch. + * @alias compute.instanceGroupManagers.updatePerInstanceConfigs + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroupManager The name of the managed instance group. It should conform to RFC1035. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone where the managed instance group is located. It should conform to RFC1035. + * @param {().InstanceGroupManagersUpdatePerInstanceConfigsReq} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + updatePerInstanceConfigs( + params?: Params$Resource$Instancegroupmanagers$Updateperinstanceconfigs, + options?: MethodOptions + ): GaxiosPromise; + updatePerInstanceConfigs( + params: Params$Resource$Instancegroupmanagers$Updateperinstanceconfigs, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updatePerInstanceConfigs( + params: Params$Resource$Instancegroupmanagers$Updateperinstanceconfigs, + callback: BodyResponseCallback + ): void; + updatePerInstanceConfigs( + callback: BodyResponseCallback + ): void; + updatePerInstanceConfigs( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagers$Updateperinstanceconfigs + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagers$Updateperinstanceconfigs; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroupmanagers$Updateperinstanceconfigs; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Instancegroupmanagers$Abandoninstances @@ -33373,6 +34425,31 @@ export namespace compute_beta { */ requestBody?: Schema$InstanceGroupManagersDeleteInstancesRequest; } + export interface Params$Resource$Instancegroupmanagers$Deleteperinstanceconfigs + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the managed instance group. It should conform to RFC1035. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone where the managed instance group is located. It should conform to RFC1035. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManagersDeletePerInstanceConfigsReq; + } export interface Params$Resource$Instancegroupmanagers$Get extends StandardParameters { /** @@ -33450,6 +34527,42 @@ export namespace compute_beta { */ zone?: string; } + export interface Params$Resource$Instancegroupmanagers$Listerrors + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)|[1-9][0-9]{0,19}. + */ + instanceGroupManager?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone where the managed instance group is located. It should conform to RFC1035. + */ + zone?: string; + } export interface Params$Resource$Instancegroupmanagers$Listmanagedinstances extends StandardParameters { /** @@ -33486,6 +34599,42 @@ export namespace compute_beta { */ zone?: string; } + export interface Params$Resource$Instancegroupmanagers$Listperinstanceconfigs + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The name of the managed instance group. It should conform to RFC1035. + */ + instanceGroupManager?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone where the managed instance group is located. It should conform to RFC1035. + */ + zone?: string; + } export interface Params$Resource$Instancegroupmanagers$Patch extends StandardParameters { /** @@ -33515,6 +34664,35 @@ export namespace compute_beta { */ requestBody?: Schema$InstanceGroupManager; } + export interface Params$Resource$Instancegroupmanagers$Patchperinstanceconfigs + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the managed instance group. It should conform to RFC1035. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone where the managed instance group is located. It should conform to RFC1035. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManagersPatchPerInstanceConfigsReq; + } export interface Params$Resource$Instancegroupmanagers$Recreateinstances extends StandardParameters { /** @@ -33742,6 +34920,35 @@ export namespace compute_beta { */ requestBody?: Schema$InstanceGroupManager; } + export interface Params$Resource$Instancegroupmanagers$Updateperinstanceconfigs + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the managed instance group. It should conform to RFC1035. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone where the managed instance group is located. It should conform to RFC1035. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManagersUpdatePerInstanceConfigsReq; + } export class Resource$Instancegroups { context: APIRequestContext; @@ -33751,7 +34958,7 @@ export namespace compute_beta { /** * compute.instanceGroups.addInstances - * @desc Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information. (== suppress_warning http-rest-shadowed ==) + * @desc Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information. * @example * * // BEFORE RUNNING: * // --------------- @@ -33889,7 +35096,7 @@ export namespace compute_beta { /** * compute.instanceGroups.aggregatedList - * @desc Retrieves the list of instance groups and sorts them by zone. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of instance groups and sorts them by zone. * @example * * // BEFORE RUNNING: * // --------------- @@ -34037,7 +35244,7 @@ export namespace compute_beta { /** * compute.instanceGroups.delete - * @desc Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information. * @example * * // BEFORE RUNNING: * // --------------- @@ -34170,7 +35377,7 @@ export namespace compute_beta { /** * compute.instanceGroups.get - * @desc Returns the specified instance group. Gets a list of available instance groups by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified instance group. Gets a list of available instance groups by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -34302,7 +35509,7 @@ export namespace compute_beta { /** * compute.instanceGroups.insert - * @desc Creates an instance group in the specified project using the parameters that are included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates an instance group in the specified project using the parameters that are included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -34436,7 +35643,7 @@ export namespace compute_beta { /** * compute.instanceGroups.list - * @desc Retrieves the list of instance groups that are located in the specified project and zone. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of instance groups that are located in the specified project and zone. * @example * * // BEFORE RUNNING: * // --------------- @@ -34581,7 +35788,7 @@ export namespace compute_beta { /** * compute.instanceGroups.listInstances - * @desc Lists the instances in the specified instance group. (== suppress_warning http-rest-shadowed ==) + * @desc Lists the instances in the specified instance group. * @example * * // BEFORE RUNNING: * // --------------- @@ -34742,7 +35949,7 @@ export namespace compute_beta { /** * compute.instanceGroups.removeInstances - * @desc Removes one or more instances from the specified instance group, but does not delete those instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted. (== suppress_warning http-rest-shadowed ==) + * @desc Removes one or more instances from the specified instance group, but does not delete those instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted. * @example * * // BEFORE RUNNING: * // --------------- @@ -34880,7 +36087,7 @@ export namespace compute_beta { /** * compute.instanceGroups.setNamedPorts - * @desc Sets the named ports for the specified instance group. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the named ports for the specified instance group. * @example * * // BEFORE RUNNING: * // --------------- @@ -35018,7 +36225,7 @@ export namespace compute_beta { /** * compute.instanceGroups.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -35449,7 +36656,7 @@ export namespace compute_beta { /** * compute.instances.addAccessConfig - * @desc Adds an access config to an instance's network interface. (== suppress_warning http-rest-shadowed ==) + * @desc Adds an access config to an instance's network interface. * @example * * // BEFORE RUNNING: * // --------------- @@ -35591,7 +36798,7 @@ export namespace compute_beta { /** * compute.instances.aggregatedList - * @desc Retrieves aggregated list of all of the instances in your project across all regions and zones. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves aggregated list of all of the instances in your project across all regions and zones. * @example * * // BEFORE RUNNING: * // --------------- @@ -35735,7 +36942,7 @@ export namespace compute_beta { /** * compute.instances.attachDisk - * @desc Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance. (== suppress_warning http-rest-shadowed ==) + * @desc Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance. * @example * * // BEFORE RUNNING: * // --------------- @@ -35874,7 +37081,7 @@ export namespace compute_beta { /** * compute.instances.delete - * @desc Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance. * @example * * // BEFORE RUNNING: * // --------------- @@ -36006,7 +37213,7 @@ export namespace compute_beta { /** * compute.instances.deleteAccessConfig - * @desc Deletes an access config from an instance's network interface. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes an access config from an instance's network interface. * @example * * // BEFORE RUNNING: * // --------------- @@ -36153,7 +37360,7 @@ export namespace compute_beta { /** * compute.instances.detachDisk - * @desc Detaches a disk from an instance. (== suppress_warning http-rest-shadowed ==) + * @desc Detaches a disk from an instance. * @example * * // BEFORE RUNNING: * // --------------- @@ -36290,7 +37497,7 @@ export namespace compute_beta { /** * compute.instances.get - * @desc Returns the specified Instance resource. Gets a list of available instances by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified Instance resource. Gets a list of available instances by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -36419,7 +37626,7 @@ export namespace compute_beta { /** * compute.instances.getGuestAttributes - * @desc Returns the specified guest attributes entry. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified guest attributes entry. * @alias compute.instances.getGuestAttributes * @memberOf! () * @@ -36499,7 +37706,7 @@ export namespace compute_beta { /** * compute.instances.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.instances.getIamPolicy * @memberOf! () * @@ -36574,7 +37781,7 @@ export namespace compute_beta { /** * compute.instances.getSerialPortOutput - * @desc Returns the last 1 MB of serial port output from the specified instance. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the last 1 MB of serial port output from the specified instance. * @example * * // BEFORE RUNNING: * // --------------- @@ -36710,7 +37917,7 @@ export namespace compute_beta { /** * compute.instances.getShieldedInstanceIdentity - * @desc Returns the Shielded Instance Identity of an instance (== suppress_warning http-rest-shadowed ==) + * @desc Returns the Shielded Instance Identity of an instance * @alias compute.instances.getShieldedInstanceIdentity * @memberOf! () * @@ -36790,7 +37997,7 @@ export namespace compute_beta { /** * compute.instances.getShieldedVmIdentity - * @desc Returns the Shielded VM Identity of an instance (== suppress_warning http-rest-shadowed ==) + * @desc Returns the Shielded VM Identity of an instance * @alias compute.instances.getShieldedVmIdentity * @memberOf! () * @@ -36868,7 +38075,7 @@ export namespace compute_beta { /** * compute.instances.insert - * @desc Creates an instance resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates an instance resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -36933,6 +38140,7 @@ export namespace compute_beta { * @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.sourceInstanceTemplate Specifies instance template to create the instance. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate + * @param {string=} params.sourceMachineImage Specifies instance machine to create the instance. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project/global/global/machineImages/machineImage - projects/project/global/global/machineImages/machineImage - global/machineImages/machineImage * @param {string} params.zone The name of the zone for this request. * @param {().Instance} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -37002,7 +38210,7 @@ export namespace compute_beta { /** * compute.instances.list - * @desc Retrieves the list of instances contained within the specified zone. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of instances contained within the specified zone. * @example * * // BEFORE RUNNING: * // --------------- @@ -37146,7 +38354,7 @@ export namespace compute_beta { /** * compute.instances.listReferrers - * @desc Retrieves the list of referrers to instances contained within the specified zone. For more information, read Viewing Referrers to VM Instances. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of referrers to instances contained within the specified zone. For more information, read Viewing Referrers to VM Instances. * @example * * // BEFORE RUNNING: * // --------------- @@ -37300,7 +38508,7 @@ export namespace compute_beta { /** * compute.instances.reset - * @desc Performs a reset on the instance. This is a hard reset the VM does not do a graceful shutdown. For more information, see Resetting an instance. (== suppress_warning http-rest-shadowed ==) + * @desc Performs a reset on the instance. This is a hard reset the VM does not do a graceful shutdown. For more information, see Resetting an instance. * @example * * // BEFORE RUNNING: * // --------------- @@ -37432,7 +38640,7 @@ export namespace compute_beta { /** * compute.instances.resume - * @desc Resumes an instance that was suspended using the instances().suspend method. (== suppress_warning http-rest-shadowed ==) + * @desc Resumes an instance that was suspended using the instances().suspend method. * @alias compute.instances.resume * @memberOf! () * @@ -37509,7 +38717,7 @@ export namespace compute_beta { /** * compute.instances.setDeletionProtection - * @desc Sets deletion protection on the instance. (== suppress_warning http-rest-shadowed ==) + * @desc Sets deletion protection on the instance. * @example * * // BEFORE RUNNING: * // --------------- @@ -37645,7 +38853,7 @@ export namespace compute_beta { /** * compute.instances.setDiskAutoDelete - * @desc Sets the auto-delete flag for a disk attached to an instance. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the auto-delete flag for a disk attached to an instance. * @example * * // BEFORE RUNNING: * // --------------- @@ -37792,7 +39000,7 @@ export namespace compute_beta { /** * compute.instances.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.instances.setIamPolicy * @memberOf! () * @@ -37867,7 +39075,7 @@ export namespace compute_beta { /** * compute.instances.setLabels - * @desc Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) + * @desc Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation. * @example * * // BEFORE RUNNING: * // --------------- @@ -38005,7 +39213,7 @@ export namespace compute_beta { /** * compute.instances.setMachineResources - * @desc Changes the number and/or type of accelerator for a stopped instance to the values specified in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Changes the number and/or type of accelerator for a stopped instance to the values specified in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -38143,7 +39351,7 @@ export namespace compute_beta { /** * compute.instances.setMachineType - * @desc Changes the machine type for a stopped instance to the machine type specified in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Changes the machine type for a stopped instance to the machine type specified in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -38281,7 +39489,7 @@ export namespace compute_beta { /** * compute.instances.setMetadata - * @desc Sets metadata for the specified instance to the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Sets metadata for the specified instance to the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -38419,7 +39627,7 @@ export namespace compute_beta { /** * compute.instances.setMinCpuPlatform - * @desc Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform. (== suppress_warning http-rest-shadowed ==) + * @desc Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform. * @example * * // BEFORE RUNNING: * // --------------- @@ -38557,7 +39765,7 @@ export namespace compute_beta { /** * compute.instances.setScheduling - * @desc Sets an instance's scheduling options. (== suppress_warning http-rest-shadowed ==) + * @desc Sets an instance's scheduling options. * @example * * // BEFORE RUNNING: * // --------------- @@ -38695,7 +39903,7 @@ export namespace compute_beta { /** * compute.instances.setServiceAccount - * @desc Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance. * @example * * // BEFORE RUNNING: * // --------------- @@ -38833,7 +40041,7 @@ export namespace compute_beta { /** * compute.instances.setShieldedInstanceIntegrityPolicy - * @desc Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.instances.setShieldedInstanceIntegrityPolicy * @memberOf! () * @@ -38913,7 +40121,7 @@ export namespace compute_beta { /** * compute.instances.setShieldedVmIntegrityPolicy - * @desc Sets the Shielded VM integrity policy for a VM instance. You can only use this method on a running VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the Shielded VM integrity policy for a VM instance. You can only use this method on a running VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.instances.setShieldedVmIntegrityPolicy * @memberOf! () * @@ -38993,7 +40201,7 @@ export namespace compute_beta { /** * compute.instances.setTags - * @desc Sets network tags for the specified instance to the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Sets network tags for the specified instance to the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -39131,7 +40339,7 @@ export namespace compute_beta { /** * compute.instances.simulateMaintenanceEvent - * @desc Simulates a maintenance event on the instance. (== suppress_warning http-rest-shadowed ==) + * @desc Simulates a maintenance event on the instance. * @alias compute.instances.simulateMaintenanceEvent * @memberOf! () * @@ -39209,7 +40417,7 @@ export namespace compute_beta { /** * compute.instances.start - * @desc Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. (== suppress_warning http-rest-shadowed ==) + * @desc Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. * @example * * // BEFORE RUNNING: * // --------------- @@ -39341,7 +40549,7 @@ export namespace compute_beta { /** * compute.instances.startWithEncryptionKey - * @desc Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. (== suppress_warning http-rest-shadowed ==) + * @desc Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. * @example * * // BEFORE RUNNING: * // --------------- @@ -39481,7 +40689,7 @@ export namespace compute_beta { /** * compute.instances.stop - * @desc Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance. (== suppress_warning http-rest-shadowed ==) + * @desc Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance. * @example * * // BEFORE RUNNING: * // --------------- @@ -39613,7 +40821,7 @@ export namespace compute_beta { /** * compute.instances.suspend - * @desc This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances incur reduced per-minute, virtual machine usage charges while they are suspended. Any resources the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. (== suppress_warning http-rest-shadowed ==) + * @desc This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances incur reduced per-minute, virtual machine usage charges while they are suspended. Any resources the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. * @alias compute.instances.suspend * @memberOf! () * @@ -39691,7 +40899,7 @@ export namespace compute_beta { /** * compute.instances.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -39832,7 +41040,7 @@ export namespace compute_beta { /** * compute.instances.updateAccessConfig - * @desc Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- @@ -39974,7 +41182,7 @@ export namespace compute_beta { /** * compute.instances.updateDisplayDevice - * @desc Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.instances.updateDisplayDevice * @memberOf! () * @@ -40052,7 +41260,7 @@ export namespace compute_beta { /** * compute.instances.updateNetworkInterface - * @desc Updates an instance's network interface. This method follows PATCH semantics. (== suppress_warning http-rest-shadowed ==) + * @desc Updates an instance's network interface. This method follows PATCH semantics. * @example * * // BEFORE RUNNING: * // --------------- @@ -40197,7 +41405,7 @@ export namespace compute_beta { /** * compute.instances.updateShieldedInstanceConfig - * @desc Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.instances.updateShieldedInstanceConfig * @memberOf! () * @@ -40277,7 +41485,7 @@ export namespace compute_beta { /** * compute.instances.updateShieldedVmConfig - * @desc Updates the Shielded VM config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the Shielded VM config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.instances.updateShieldedVmConfig * @memberOf! () * @@ -40690,6 +41898,10 @@ export namespace compute_beta { * Specifies instance template to create the instance. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate */ sourceInstanceTemplate?: string; + /** + * Specifies instance machine to create the instance. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project/global/global/machineImages/machineImage - projects/project/global/global/machineImages/machineImage - global/machineImages/machineImage + */ + sourceMachineImage?: string; /** * The name of the zone for this request. */ @@ -41503,7 +42715,7 @@ export namespace compute_beta { /** * compute.instanceTemplates.delete - * @desc Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are already in use by a managed instance group. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are already in use by a managed instance group. * @example * * // BEFORE RUNNING: * // --------------- @@ -41632,7 +42844,7 @@ export namespace compute_beta { /** * compute.instanceTemplates.get - * @desc Returns the specified instance template. Gets a list of available instance templates by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified instance template. Gets a list of available instance templates by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -41760,7 +42972,7 @@ export namespace compute_beta { /** * compute.instanceTemplates.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.instanceTemplates.getIamPolicy * @memberOf! () * @@ -41834,7 +43046,7 @@ export namespace compute_beta { /** * compute.instanceTemplates.insert - * @desc Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template. (== suppress_warning http-rest-shadowed ==) + * @desc Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template. * @example * * // BEFORE RUNNING: * // --------------- @@ -41964,7 +43176,7 @@ export namespace compute_beta { /** * compute.instanceTemplates.list - * @desc Retrieves a list of instance templates that are contained within the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of instance templates that are contained within the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -42107,7 +43319,7 @@ export namespace compute_beta { /** * compute.instanceTemplates.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.instanceTemplates.setIamPolicy * @memberOf! () * @@ -42181,7 +43393,7 @@ export namespace compute_beta { /** * compute.instanceTemplates.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -42473,7 +43685,7 @@ export namespace compute_beta { /** * compute.interconnectAttachments.aggregatedList - * @desc Retrieves an aggregated list of interconnect attachments. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of interconnect attachments. * @example * * // BEFORE RUNNING: * // --------------- @@ -42631,7 +43843,7 @@ export namespace compute_beta { /** * compute.interconnectAttachments.delete - * @desc Deletes the specified interconnect attachment. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified interconnect attachment. * @example * * // BEFORE RUNNING: * // --------------- @@ -42764,7 +43976,7 @@ export namespace compute_beta { /** * compute.interconnectAttachments.get - * @desc Returns the specified interconnect attachment. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified interconnect attachment. * @example * * // BEFORE RUNNING: * // --------------- @@ -42898,7 +44110,7 @@ export namespace compute_beta { /** * compute.interconnectAttachments.insert - * @desc Creates an InterconnectAttachment in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates an InterconnectAttachment in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -42963,6 +44175,7 @@ export namespace compute_beta { * @param {string} params.project Project ID for this request. * @param {string} params.region Name of the region for this request. * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {boolean=} params.validateOnly If true, the request will not be committed. * @param {().InterconnectAttachment} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -43032,7 +44245,7 @@ export namespace compute_beta { /** * compute.interconnectAttachments.list - * @desc Retrieves the list of interconnect attachments contained within the specified region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of interconnect attachments contained within the specified region. * @example * * // BEFORE RUNNING: * // --------------- @@ -43184,7 +44397,7 @@ export namespace compute_beta { /** * compute.interconnectAttachments.patch - * @desc Updates the specified interconnect attachment with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified interconnect attachment with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.interconnectAttachments.patch * @memberOf! () * @@ -43262,7 +44475,7 @@ export namespace compute_beta { /** * compute.interconnectAttachments.setLabels - * @desc Sets the labels on an InterconnectAttachment. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the labels on an InterconnectAttachment. To learn more about labels, read the Labeling Resources documentation. * @alias compute.interconnectAttachments.setLabels * @memberOf! () * @@ -43340,7 +44553,7 @@ export namespace compute_beta { /** * compute.interconnectAttachments.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -43571,6 +44784,10 @@ export namespace compute_beta { * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; + /** + * If true, the request will not be committed. + */ + validateOnly?: boolean; /** * Request body metadata @@ -43701,7 +44918,7 @@ export namespace compute_beta { /** * compute.interconnectLocations.get - * @desc Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -43831,7 +45048,7 @@ export namespace compute_beta { /** * compute.interconnectLocations.list - * @desc Retrieves the list of interconnect locations available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of interconnect locations available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -44026,7 +45243,7 @@ export namespace compute_beta { /** * compute.interconnects.delete - * @desc Deletes the specified interconnect. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified interconnect. * @example * * // BEFORE RUNNING: * // --------------- @@ -44155,7 +45372,7 @@ export namespace compute_beta { /** * compute.interconnects.get - * @desc Returns the specified interconnect. Get a list of available interconnects by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified interconnect. Get a list of available interconnects by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -44283,7 +45500,7 @@ export namespace compute_beta { /** * compute.interconnects.getDiagnostics - * @desc Returns the interconnectDiagnostics for the specified interconnect. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the interconnectDiagnostics for the specified interconnect. * @alias compute.interconnects.getDiagnostics * @memberOf! () * @@ -44369,7 +45586,7 @@ export namespace compute_beta { /** * compute.interconnects.insert - * @desc Creates a Interconnect in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a Interconnect in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -44498,7 +45715,7 @@ export namespace compute_beta { /** * compute.interconnects.list - * @desc Retrieves the list of interconnect available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of interconnect available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -44638,7 +45855,7 @@ export namespace compute_beta { /** * compute.interconnects.patch - * @desc Updates the specified interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- @@ -44773,7 +45990,7 @@ export namespace compute_beta { /** * compute.interconnects.setLabels - * @desc Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation. * @alias compute.interconnects.setLabels * @memberOf! () * @@ -44849,7 +46066,7 @@ export namespace compute_beta { /** * compute.interconnects.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -45162,7 +46379,7 @@ export namespace compute_beta { /** * compute.licenseCodes.get - * @desc Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code. (== suppress_warning http-rest-shadowed ==) + * @desc Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code. * @alias compute.licenseCodes.get * @memberOf! () * @@ -45259,7 +46476,7 @@ export namespace compute_beta { /** * compute.licenses.delete - * @desc Deletes the specified license. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified license. * @alias compute.licenses.delete * @memberOf! () * @@ -45334,7 +46551,7 @@ export namespace compute_beta { /** * compute.licenses.get - * @desc Returns the specified License resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified License resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -45459,7 +46676,7 @@ export namespace compute_beta { /** * compute.licenses.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.licenses.getIamPolicy * @memberOf! () * @@ -45533,7 +46750,7 @@ export namespace compute_beta { /** * compute.licenses.insert - * @desc Create a License resource in the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Create a License resource in the specified project. * @alias compute.licenses.insert * @memberOf! () * @@ -45607,7 +46824,7 @@ export namespace compute_beta { /** * compute.licenses.list - * @desc Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. * @alias compute.licenses.list * @memberOf! () * @@ -45685,7 +46902,7 @@ export namespace compute_beta { /** * compute.licenses.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.licenses.setIamPolicy * @memberOf! () * @@ -45881,6 +47098,697 @@ export namespace compute_beta { requestBody?: Schema$GlobalSetPolicyRequest; } + export class Resource$Machineimages { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.machineImages.delete + * @desc Deletes the specified machine image. Deleting a machine image is permanent and cannot be undone. + * @alias compute.machineImages.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.machineImage The name of the machine image 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 {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Machineimages$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Machineimages$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Machineimages$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Machineimages$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Machineimages$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Machineimages$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/global/machineImages/{machineImage}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'machineImage'], + pathParams: ['machineImage', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.machineImages.get + * @desc Returns the specified machine image. Gets a list of available machine images by making a list() request. + * @alias compute.machineImages.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.machineImage The name of the machine image. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Machineimages$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Machineimages$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Machineimages$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Machineimages$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Machineimages$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Machineimages$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/global/machineImages/{machineImage}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'machineImage'], + pathParams: ['machineImage', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.machineImages.getIamPolicy + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @alias compute.machineImages.getIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.optionsRequestedPolicyVersion Requested IAM Policy version. + * @param {string} params.project Project ID for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIamPolicy( + params?: Params$Resource$Machineimages$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Machineimages$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Machineimages$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Machineimages$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Machineimages$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Machineimages$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/global/machineImages/{resource}/getIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.machineImages.insert + * @desc Creates a machine image in the specified project using the data that is included in the request. If you are creating a new machine image to update an existing instance, your new machine image should use the same network or, if applicable, the same subnetwork as the original instance. + * @alias compute.machineImages.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string=} params.sourceInstance Required. Source instance that is used to create the machine image from. + * @param {().MachineImage} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Machineimages$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Machineimages$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Machineimages$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Machineimages$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Machineimages$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Machineimages$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/compute/beta/projects/{project}/global/machineImages' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.machineImages.list + * @desc Retrieves a list of machine images that are contained within the specified project. + * @alias compute.machineImages.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Machineimages$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Machineimages$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Machineimages$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Machineimages$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Machineimages$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Machineimages$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/compute/beta/projects/{project}/global/machineImages' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.machineImages.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @alias compute.machineImages.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().GlobalSetPolicyRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setIamPolicy( + params?: Params$Resource$Machineimages$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Machineimages$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Machineimages$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Machineimages$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Machineimages$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Machineimages$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/global/machineImages/{resource}/setIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.machineImages.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.machineImages.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().TestPermissionsRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Machineimages$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Machineimages$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Machineimages$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Machineimages$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Machineimages$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Machineimages$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/global/machineImages/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Machineimages$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the machine image to delete. + */ + machineImage?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Machineimages$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the machine image. + */ + machineImage?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Machineimages$Getiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Requested IAM Policy version. + */ + optionsRequestedPolicyVersion?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + } + export interface Params$Resource$Machineimages$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Required. Source instance that is used to create the machine image from. + */ + sourceInstance?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$MachineImage; + } + export interface Params$Resource$Machineimages$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Machineimages$Setiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GlobalSetPolicyRequest; + } + export interface Params$Resource$Machineimages$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + export class Resource$Machinetypes { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -45889,7 +47797,7 @@ export namespace compute_beta { /** * compute.machineTypes.aggregatedList - * @desc Retrieves an aggregated list of machine types. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of machine types. * @example * * // BEFORE RUNNING: * // --------------- @@ -46037,7 +47945,7 @@ export namespace compute_beta { /** * compute.machineTypes.get - * @desc Returns the specified machine type. Gets a list of available machine types by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified machine type. Gets a list of available machine types by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -46168,7 +48076,7 @@ export namespace compute_beta { /** * compute.machineTypes.list - * @desc Retrieves a list of machine types available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of machine types available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -46400,7 +48308,7 @@ export namespace compute_beta { /** * compute.networkEndpointGroups.aggregatedList - * @desc Retrieves the list of network endpoint groups and sorts them by zone. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of network endpoint groups and sorts them by zone. * @alias compute.networkEndpointGroups.aggregatedList * @memberOf! () * @@ -46487,7 +48395,7 @@ export namespace compute_beta { /** * compute.networkEndpointGroups.attachNetworkEndpoints - * @desc Attach a list of network endpoints to the specified network endpoint group. (== suppress_warning http-rest-shadowed ==) + * @desc Attach a list of network endpoints to the specified network endpoint group. * @alias compute.networkEndpointGroups.attachNetworkEndpoints * @memberOf! () * @@ -46567,7 +48475,7 @@ export namespace compute_beta { /** * compute.networkEndpointGroups.delete - * @desc Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it. (== suppress_warning http-rest-shadowed ==) + * @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! () * @@ -46644,7 +48552,7 @@ export namespace compute_beta { /** * compute.networkEndpointGroups.detachNetworkEndpoints - * @desc Detach a list of network endpoints from the specified network endpoint group. (== suppress_warning http-rest-shadowed ==) + * @desc Detach a list of network endpoints from the specified network endpoint group. * @alias compute.networkEndpointGroups.detachNetworkEndpoints * @memberOf! () * @@ -46724,7 +48632,7 @@ export namespace compute_beta { /** * compute.networkEndpointGroups.get - * @desc Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request. * @alias compute.networkEndpointGroups.get * @memberOf! () * @@ -46802,7 +48710,7 @@ export namespace compute_beta { /** * compute.networkEndpointGroups.insert - * @desc Creates a network endpoint group in the specified project using the parameters that are included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a network endpoint group in the specified project using the parameters that are included in the request. * @alias compute.networkEndpointGroups.insert * @memberOf! () * @@ -46879,7 +48787,7 @@ export namespace compute_beta { /** * compute.networkEndpointGroups.list - * @desc Retrieves the list of network endpoint groups that are located in the specified project and zone. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of network endpoint groups that are located in the specified project and zone. * @alias compute.networkEndpointGroups.list * @memberOf! () * @@ -46960,7 +48868,7 @@ export namespace compute_beta { /** * compute.networkEndpointGroups.listNetworkEndpoints - * @desc Lists the network endpoints in the specified network endpoint group. (== suppress_warning http-rest-shadowed ==) + * @desc Lists the network endpoints in the specified network endpoint group. * @alias compute.networkEndpointGroups.listNetworkEndpoints * @memberOf! () * @@ -47064,7 +48972,7 @@ export namespace compute_beta { /** * compute.networkEndpointGroups.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.networkEndpointGroups.testIamPermissions * @memberOf! () * @@ -47406,7 +49314,7 @@ export namespace compute_beta { /** * compute.networks.addPeering - * @desc Adds a peering to the specified network. (== suppress_warning http-rest-shadowed ==) + * @desc Adds a peering to the specified network. * @example * * // BEFORE RUNNING: * // --------------- @@ -47540,7 +49448,7 @@ export namespace compute_beta { /** * compute.networks.delete - * @desc Deletes the specified network. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified network. * @example * * // BEFORE RUNNING: * // --------------- @@ -47668,7 +49576,7 @@ export namespace compute_beta { /** * compute.networks.get - * @desc Returns the specified network. Gets a list of available networks by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified network. Gets a list of available networks by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -47793,7 +49701,7 @@ export namespace compute_beta { /** * compute.networks.insert - * @desc Creates a network in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a network in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -47921,7 +49829,7 @@ export namespace compute_beta { /** * compute.networks.list - * @desc Retrieves the list of networks available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of networks available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -48060,7 +49968,7 @@ export namespace compute_beta { /** * compute.networks.listPeeringRoutes - * @desc Lists the peering routes exchanged over peering connection. (== suppress_warning http-rest-shadowed ==) + * @desc Lists the peering routes exchanged over peering connection. * @alias compute.networks.listPeeringRoutes * @memberOf! () * @@ -48149,7 +50057,7 @@ export namespace compute_beta { /** * compute.networks.patch - * @desc Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode. (== suppress_warning http-rest-shadowed ==) + * @desc Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode. * @example * * // BEFORE RUNNING: * // --------------- @@ -48283,7 +50191,7 @@ export namespace compute_beta { /** * compute.networks.removePeering - * @desc Removes a peering from the specified network. (== suppress_warning http-rest-shadowed ==) + * @desc Removes a peering from the specified network. * @example * * // BEFORE RUNNING: * // --------------- @@ -48417,7 +50325,7 @@ export namespace compute_beta { /** * compute.networks.switchToCustomMode - * @desc Switches the network mode from auto subnet mode to custom subnet mode. (== suppress_warning http-rest-shadowed ==) + * @desc Switches the network mode from auto subnet mode to custom subnet mode. * @example * * // BEFORE RUNNING: * // --------------- @@ -48546,7 +50454,7 @@ export namespace compute_beta { /** * compute.networks.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -48683,7 +50591,7 @@ export namespace compute_beta { /** * compute.networks.updatePeering - * @desc Updates the specified network peering with the data included in the request Only the following fields can be modified: NetworkPeering.export_custom_routes, and NetworkPeering.import_custom_routes (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified network peering with the data included in the request Only the following fields can be modified: NetworkPeering.export_custom_routes, and NetworkPeering.import_custom_routes * @alias compute.networks.updatePeering * @memberOf! () * @@ -49033,7 +50941,7 @@ export namespace compute_beta { /** * compute.nodeGroups.addNodes - * @desc Adds specified number of nodes to the node group. (== suppress_warning http-rest-shadowed ==) + * @desc Adds specified number of nodes to the node group. * @alias compute.nodeGroups.addNodes * @memberOf! () * @@ -49111,7 +51019,7 @@ export namespace compute_beta { /** * compute.nodeGroups.aggregatedList - * @desc Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group. * @alias compute.nodeGroups.aggregatedList * @memberOf! () * @@ -49192,7 +51100,7 @@ export namespace compute_beta { /** * compute.nodeGroups.delete - * @desc Deletes the specified NodeGroup resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified NodeGroup resource. * @alias compute.nodeGroups.delete * @memberOf! () * @@ -49269,7 +51177,7 @@ export namespace compute_beta { /** * compute.nodeGroups.deleteNodes - * @desc Deletes specified nodes from the node group. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes specified nodes from the node group. * @alias compute.nodeGroups.deleteNodes * @memberOf! () * @@ -49347,7 +51255,7 @@ export namespace compute_beta { /** * compute.nodeGroups.get - * @desc Returns the specified NodeGroup. Get a list of available NodeGroups by making a list() request. Note: the "nodes" field should not be used. Use nodeGroups.listNodes instead. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified NodeGroup. Get a list of available NodeGroups by making a list() request. Note: the "nodes" field should not be used. Use nodeGroups.listNodes instead. * @alias compute.nodeGroups.get * @memberOf! () * @@ -49422,7 +51330,7 @@ export namespace compute_beta { /** * compute.nodeGroups.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.nodeGroups.getIamPolicy * @memberOf! () * @@ -49497,7 +51405,7 @@ export namespace compute_beta { /** * compute.nodeGroups.insert - * @desc Creates a NodeGroup resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a NodeGroup resource in the specified project using the data included in the request. * @alias compute.nodeGroups.insert * @memberOf! () * @@ -49575,7 +51483,7 @@ export namespace compute_beta { /** * compute.nodeGroups.list - * @desc Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group. * @alias compute.nodeGroups.list * @memberOf! () * @@ -49653,7 +51561,7 @@ export namespace compute_beta { /** * compute.nodeGroups.listNodes - * @desc Lists nodes in the node group. (== suppress_warning http-rest-shadowed ==) + * @desc Lists nodes in the node group. * @alias compute.nodeGroups.listNodes * @memberOf! () * @@ -49731,9 +51639,86 @@ export namespace compute_beta { } } + /** + * compute.nodeGroups.patch + * @desc Patch the node group. + * @alias compute.nodeGroups.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.nodeGroup Name of the NodeGroup resource to update. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone for this request. + * @param {().NodeGroup} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Nodegroups$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Nodegroups$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Nodegroups$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Nodegroups$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Nodegroups$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodegroups$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'nodeGroup'], + pathParams: ['nodeGroup', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * compute.nodeGroups.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.nodeGroups.setIamPolicy * @memberOf! () * @@ -49808,7 +51793,7 @@ export namespace compute_beta { /** * compute.nodeGroups.setNodeTemplate - * @desc Updates the node template of the node group. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the node template of the node group. * @alias compute.nodeGroups.setNodeTemplate * @memberOf! () * @@ -49886,7 +51871,7 @@ export namespace compute_beta { /** * compute.nodeGroups.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.nodeGroups.testIamPermissions * @memberOf! () * @@ -50215,6 +52200,34 @@ export namespace compute_beta { */ zone?: string; } + export interface Params$Resource$Nodegroups$Patch extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the NodeGroup resource to update. + */ + nodeGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NodeGroup; + } export interface Params$Resource$Nodegroups$Setiampolicy extends StandardParameters { /** @@ -50303,7 +52316,7 @@ export namespace compute_beta { /** * compute.nodeTemplates.aggregatedList - * @desc Retrieves an aggregated list of node templates. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of node templates. * @alias compute.nodeTemplates.aggregatedList * @memberOf! () * @@ -50388,7 +52401,7 @@ export namespace compute_beta { /** * compute.nodeTemplates.delete - * @desc Deletes the specified NodeTemplate resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified NodeTemplate resource. * @alias compute.nodeTemplates.delete * @memberOf! () * @@ -50465,7 +52478,7 @@ export namespace compute_beta { /** * compute.nodeTemplates.get - * @desc Returns the specified node template. Gets a list of available node templates by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified node template. Gets a list of available node templates by making a list() request. * @alias compute.nodeTemplates.get * @memberOf! () * @@ -50541,7 +52554,7 @@ export namespace compute_beta { /** * compute.nodeTemplates.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.nodeTemplates.getIamPolicy * @memberOf! () * @@ -50616,7 +52629,7 @@ export namespace compute_beta { /** * compute.nodeTemplates.insert - * @desc Creates a NodeTemplate resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a NodeTemplate resource in the specified project using the data included in the request. * @alias compute.nodeTemplates.insert * @memberOf! () * @@ -50693,7 +52706,7 @@ export namespace compute_beta { /** * compute.nodeTemplates.list - * @desc Retrieves a list of node templates available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of node templates available to the specified project. * @alias compute.nodeTemplates.list * @memberOf! () * @@ -50772,7 +52785,7 @@ export namespace compute_beta { /** * compute.nodeTemplates.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.nodeTemplates.setIamPolicy * @memberOf! () * @@ -50847,7 +52860,7 @@ export namespace compute_beta { /** * compute.nodeTemplates.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.nodeTemplates.testIamPermissions * @memberOf! () * @@ -51139,7 +53152,7 @@ export namespace compute_beta { /** * compute.nodeTypes.aggregatedList - * @desc Retrieves an aggregated list of node types. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of node types. * @alias compute.nodeTypes.aggregatedList * @memberOf! () * @@ -51220,7 +53233,7 @@ export namespace compute_beta { /** * compute.nodeTypes.get - * @desc Returns the specified node type. Gets a list of available node types by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified node type. Gets a list of available node types by making a list() request. * @alias compute.nodeTypes.get * @memberOf! () * @@ -51293,7 +53306,7 @@ export namespace compute_beta { /** * compute.nodeTypes.list - * @desc Retrieves a list of node types available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of node types available to the specified project. * @alias compute.nodeTypes.list * @memberOf! () * @@ -51457,7 +53470,7 @@ export namespace compute_beta { /** * compute.packetMirrorings.aggregatedList - * @desc Retrieves an aggregated list of packetMirrorings. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of packetMirrorings. * @alias compute.packetMirrorings.aggregatedList * @memberOf! () * @@ -51544,7 +53557,7 @@ export namespace compute_beta { /** * compute.packetMirrorings.delete - * @desc Deletes the specified PacketMirroring resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified PacketMirroring resource. * @alias compute.packetMirrorings.delete * @memberOf! () * @@ -51621,7 +53634,7 @@ export namespace compute_beta { /** * compute.packetMirrorings.get - * @desc Returns the specified PacketMirroring resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified PacketMirroring resource. * @alias compute.packetMirrorings.get * @memberOf! () * @@ -51697,7 +53710,7 @@ export namespace compute_beta { /** * compute.packetMirrorings.insert - * @desc Creates a PacketMirroring resource in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a PacketMirroring resource in the specified project and region using the data included in the request. * @alias compute.packetMirrorings.insert * @memberOf! () * @@ -51774,7 +53787,7 @@ export namespace compute_beta { /** * compute.packetMirrorings.list - * @desc Retrieves a list of PacketMirroring resources available to the specified project and region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of PacketMirroring resources available to the specified project and region. * @alias compute.packetMirrorings.list * @memberOf! () * @@ -51853,7 +53866,7 @@ export namespace compute_beta { /** * compute.packetMirrorings.patch - * @desc Patches the specified PacketMirroring resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Patches the specified PacketMirroring resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. * @alias compute.packetMirrorings.patch * @memberOf! () * @@ -51931,7 +53944,7 @@ export namespace compute_beta { /** * compute.packetMirrorings.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.packetMirrorings.testIamPermissions * @memberOf! () * @@ -52203,7 +54216,7 @@ export namespace compute_beta { /** * compute.projects.disableXpnHost - * @desc Disable this project as a shared VPC host project. (== suppress_warning http-rest-shadowed ==) + * @desc Disable this project as a shared VPC host project. * @example * * // BEFORE RUNNING: * // --------------- @@ -52327,7 +54340,7 @@ export namespace compute_beta { /** * compute.projects.disableXpnResource - * @desc Disable a service resource (also known as service project) associated with this host project. (== suppress_warning http-rest-shadowed ==) + * @desc Disable a service resource (also known as service project) associated with this host project. * @example * * // BEFORE RUNNING: * // --------------- @@ -52456,7 +54469,7 @@ export namespace compute_beta { /** * compute.projects.enableXpnHost - * @desc Enable this project as a shared VPC host project. (== suppress_warning http-rest-shadowed ==) + * @desc Enable this project as a shared VPC host project. * @example * * // BEFORE RUNNING: * // --------------- @@ -52580,7 +54593,7 @@ export namespace compute_beta { /** * compute.projects.enableXpnResource - * @desc Enable service resource (a.k.a service project) for a host project, so that subnets in the host project can be used by instances in the service project. (== suppress_warning http-rest-shadowed ==) + * @desc Enable service resource (a.k.a service project) for a host project, so that subnets in the host project can be used by instances in the service project. * @example * * // BEFORE RUNNING: * // --------------- @@ -52709,7 +54722,7 @@ export namespace compute_beta { /** * compute.projects.get - * @desc Returns the specified Project resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified Project resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -52830,7 +54843,7 @@ export namespace compute_beta { /** * compute.projects.getXpnHost - * @desc Gets the shared VPC host project that this project links to. May be empty if no link exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the shared VPC host project that this project links to. May be empty if no link exists. * @example * * // BEFORE RUNNING: * // --------------- @@ -52951,7 +54964,7 @@ export namespace compute_beta { /** * compute.projects.getXpnResources - * @desc Gets service resources (a.k.a service project) associated with this host project. (== suppress_warning http-rest-shadowed ==) + * @desc Gets service resources (a.k.a service project) associated with this host project. * @example * * // BEFORE RUNNING: * // --------------- @@ -53095,7 +55108,7 @@ export namespace compute_beta { /** * compute.projects.listXpnHosts - * @desc Lists all shared VPC host projects visible to the user in an organization. (== suppress_warning http-rest-shadowed ==) + * @desc Lists all shared VPC host projects visible to the user in an organization. * @example * * // BEFORE RUNNING: * // --------------- @@ -53240,7 +55253,7 @@ export namespace compute_beta { /** * compute.projects.moveDisk - * @desc Moves a persistent disk from one zone to another. (== suppress_warning http-rest-shadowed ==) + * @desc Moves a persistent disk from one zone to another. * @example * * // BEFORE RUNNING: * // --------------- @@ -53369,7 +55382,7 @@ export namespace compute_beta { /** * compute.projects.moveInstance - * @desc Moves an instance and its attached persistent disks from one zone to another. (== suppress_warning http-rest-shadowed ==) + * @desc Moves an instance and its attached persistent disks from one zone to another. * @example * * // BEFORE RUNNING: * // --------------- @@ -53498,7 +55511,7 @@ export namespace compute_beta { /** * compute.projects.setCommonInstanceMetadata - * @desc Sets metadata common to all instances within the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Sets metadata common to all instances within the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -53630,7 +55643,7 @@ export namespace compute_beta { /** * compute.projects.setDefaultNetworkTier - * @desc Sets the default network tier of the project. The default network tier is used when an address/forwardingRule/instance is created without specifying the network tier field. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the default network tier of the project. The default network tier is used when an address/forwardingRule/instance is created without specifying the network tier field. * @alias compute.projects.setDefaultNetworkTier * @memberOf! () * @@ -53707,7 +55720,7 @@ export namespace compute_beta { /** * compute.projects.setUsageExportBucket - * @desc Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled. (== suppress_warning http-rest-shadowed ==) + * @desc Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled. * @example * * // BEFORE RUNNING: * // --------------- @@ -54109,7 +56122,7 @@ export namespace compute_beta { /** * compute.regionAutoscalers.delete - * @desc Deletes the specified autoscaler. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified autoscaler. * @example * * // BEFORE RUNNING: * // --------------- @@ -54242,7 +56255,7 @@ export namespace compute_beta { /** * compute.regionAutoscalers.get - * @desc Returns the specified autoscaler. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified autoscaler. * @example * * // BEFORE RUNNING: * // --------------- @@ -54374,7 +56387,7 @@ export namespace compute_beta { /** * compute.regionAutoscalers.insert - * @desc Creates an autoscaler in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates an autoscaler in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -54508,7 +56521,7 @@ export namespace compute_beta { /** * compute.regionAutoscalers.list - * @desc Retrieves a list of autoscalers contained within the specified region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of autoscalers contained within the specified region. * @example * * // BEFORE RUNNING: * // --------------- @@ -54655,7 +56668,7 @@ export namespace compute_beta { /** * compute.regionAutoscalers.patch - * @desc Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- @@ -54791,7 +56804,7 @@ export namespace compute_beta { /** * compute.regionAutoscalers.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -54932,7 +56945,7 @@ export namespace compute_beta { /** * compute.regionAutoscalers.update - * @desc Updates an autoscaler in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Updates an autoscaler in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -55260,7 +57273,7 @@ export namespace compute_beta { /** * compute.regionBackendServices.delete - * @desc Deletes the specified regional BackendService resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified regional BackendService resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -55393,7 +57406,7 @@ export namespace compute_beta { /** * compute.regionBackendServices.get - * @desc Returns the specified regional BackendService resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified regional BackendService resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -55525,7 +57538,7 @@ export namespace compute_beta { /** * compute.regionBackendServices.getHealth - * @desc Gets the most recent health check results for this regional BackendService. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the most recent health check results for this regional BackendService. * @example * * // BEFORE RUNNING: * // --------------- @@ -55668,7 +57681,7 @@ export namespace compute_beta { /** * compute.regionBackendServices.insert - * @desc Creates a regional BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a regional backend service. Read Restrictions and Guidelines for more information. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a regional BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a regional backend service. Read Restrictions and Guidelines for more information. * @example * * // BEFORE RUNNING: * // --------------- @@ -55802,7 +57815,7 @@ export namespace compute_beta { /** * compute.regionBackendServices.list - * @desc Retrieves the list of regional BackendService resources available to the specified project in the given region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of regional BackendService resources available to the specified project in the given region. * @example * * // BEFORE RUNNING: * // --------------- @@ -55947,7 +57960,7 @@ export namespace compute_beta { /** * compute.regionBackendServices.patch - * @desc Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- @@ -56086,7 +58099,7 @@ export namespace compute_beta { /** * compute.regionBackendServices.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -56227,7 +58240,7 @@ export namespace compute_beta { /** * compute.regionBackendServices.update - * @desc Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. * @example * * // BEFORE RUNNING: * // --------------- @@ -56583,7 +58596,7 @@ export namespace compute_beta { /** * compute.regionCommitments.aggregatedList - * @desc Retrieves an aggregated list of commitments. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of commitments. * @example * * // BEFORE RUNNING: * // --------------- @@ -56728,7 +58741,7 @@ export namespace compute_beta { /** * compute.regionCommitments.get - * @desc Returns the specified commitment resource. Gets a list of available commitments by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified commitment resource. Gets a list of available commitments by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -56860,7 +58873,7 @@ export namespace compute_beta { /** * compute.regionCommitments.insert - * @desc Creates a commitment in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a commitment in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -56994,7 +59007,7 @@ export namespace compute_beta { /** * compute.regionCommitments.list - * @desc Retrieves a list of commitments contained within the specified region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of commitments contained within the specified region. * @example * * // BEFORE RUNNING: * // --------------- @@ -57139,7 +59152,7 @@ export namespace compute_beta { /** * compute.regionCommitments.updateReservations - * @desc Update the shape of reservations for GPUS/Local SSDs of reservations within the commitments. (== suppress_warning http-rest-shadowed ==) + * @desc Update the shape of reservations for GPUS/Local SSDs of reservations within the commitments. * @alias compute.regionCommitments.updateReservations * @memberOf! () * @@ -57359,7 +59372,7 @@ export namespace compute_beta { /** * compute.regionDisks.addResourcePolicies - * @desc Adds existing resource policies to a regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation. (== suppress_warning http-rest-shadowed ==) + * @desc Adds existing resource policies to a regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation. * @alias compute.regionDisks.addResourcePolicies * @memberOf! () * @@ -57437,7 +59450,7 @@ export namespace compute_beta { /** * compute.regionDisks.createSnapshot - * @desc Creates a snapshot of this regional disk. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a snapshot of this regional disk. * @alias compute.regionDisks.createSnapshot * @memberOf! () * @@ -57515,7 +59528,7 @@ export namespace compute_beta { /** * compute.regionDisks.delete - * @desc Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. * @alias compute.regionDisks.delete * @memberOf! () * @@ -57592,7 +59605,7 @@ export namespace compute_beta { /** * compute.regionDisks.get - * @desc Returns a specified regional persistent disk. (== suppress_warning http-rest-shadowed ==) + * @desc Returns a specified regional persistent disk. * @alias compute.regionDisks.get * @memberOf! () * @@ -57665,7 +59678,7 @@ export namespace compute_beta { /** * compute.regionDisks.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.regionDisks.getIamPolicy * @memberOf! () * @@ -57740,7 +59753,7 @@ export namespace compute_beta { /** * compute.regionDisks.insert - * @desc Creates a persistent regional disk in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a persistent regional disk in the specified project using the data included in the request. * @alias compute.regionDisks.insert * @memberOf! () * @@ -57818,7 +59831,7 @@ export namespace compute_beta { /** * compute.regionDisks.list - * @desc Retrieves the list of persistent disks contained within the specified region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of persistent disks contained within the specified region. * @alias compute.regionDisks.list * @memberOf! () * @@ -57894,7 +59907,7 @@ export namespace compute_beta { /** * compute.regionDisks.removeResourcePolicies - * @desc Removes resource policies from a regional disk. (== suppress_warning http-rest-shadowed ==) + * @desc Removes resource policies from a regional disk. * @alias compute.regionDisks.removeResourcePolicies * @memberOf! () * @@ -57974,7 +59987,7 @@ export namespace compute_beta { /** * compute.regionDisks.resize - * @desc Resizes the specified regional persistent disk. (== suppress_warning http-rest-shadowed ==) + * @desc Resizes the specified regional persistent disk. * @alias compute.regionDisks.resize * @memberOf! () * @@ -58052,7 +60065,7 @@ export namespace compute_beta { /** * compute.regionDisks.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.regionDisks.setIamPolicy * @memberOf! () * @@ -58127,7 +60140,7 @@ export namespace compute_beta { /** * compute.regionDisks.setLabels - * @desc Sets the labels on the target regional disk. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the labels on the target regional disk. * @alias compute.regionDisks.setLabels * @memberOf! () * @@ -58205,7 +60218,7 @@ export namespace compute_beta { /** * compute.regionDisks.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.regionDisks.testIamPermissions * @memberOf! () * @@ -58616,7 +60629,7 @@ export namespace compute_beta { /** * compute.regionDiskTypes.get - * @desc Returns the specified regional disk type. Gets a list of available disk types by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified regional disk type. Gets a list of available disk types by making a list() request. * @alias compute.regionDiskTypes.get * @memberOf! () * @@ -58690,7 +60703,7 @@ export namespace compute_beta { /** * compute.regionDiskTypes.list - * @desc Retrieves a list of regional disk types available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of regional disk types available to the specified project. * @alias compute.regionDiskTypes.list * @memberOf! () * @@ -58829,7 +60842,7 @@ export namespace compute_beta { /** * compute.regionHealthChecks.delete - * @desc Deletes the specified HealthCheck resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified HealthCheck resource. * @alias compute.regionHealthChecks.delete * @memberOf! () * @@ -58906,7 +60919,7 @@ export namespace compute_beta { /** * compute.regionHealthChecks.get - * @desc Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. * @alias compute.regionHealthChecks.get * @memberOf! () * @@ -58982,7 +60995,7 @@ export namespace compute_beta { /** * compute.regionHealthChecks.insert - * @desc Creates a HealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a HealthCheck resource in the specified project using the data included in the request. * @alias compute.regionHealthChecks.insert * @memberOf! () * @@ -59059,7 +61072,7 @@ export namespace compute_beta { /** * compute.regionHealthChecks.list - * @desc Retrieves the list of HealthCheck resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of HealthCheck resources available to the specified project. * @alias compute.regionHealthChecks.list * @memberOf! () * @@ -59138,7 +61151,7 @@ export namespace compute_beta { /** * compute.regionHealthChecks.patch - * @desc Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.regionHealthChecks.patch * @memberOf! () * @@ -59216,7 +61229,7 @@ export namespace compute_beta { /** * compute.regionHealthChecks.update - * @desc Updates a HealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. * @alias compute.regionHealthChecks.update * @memberOf! () * @@ -59461,7 +61474,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.abandonInstances - * @desc Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. (== suppress_warning http-rest-shadowed ==) + * @desc Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @example * * // BEFORE RUNNING: * // --------------- @@ -59599,7 +61612,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.applyUpdatesToInstances - * @desc Apply updates to selected instances the managed instance group. (== suppress_warning http-rest-shadowed ==) + * @desc Apply updates to selected instances the managed instance group. * @alias compute.regionInstanceGroupManagers.applyUpdatesToInstances * @memberOf! () * @@ -59678,7 +61691,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.createInstances - * @desc Creates instances with per-instance configs in this regional managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method. (== suppress_warning http-rest-shadowed ==) + * @desc Creates instances with per-instance configs in this regional managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method. * @alias compute.regionInstanceGroupManagers.createInstances * @memberOf! () * @@ -59756,7 +61769,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.delete - * @desc Deletes the specified managed instance group and all of the instances in that group. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified managed instance group and all of the instances in that group. * @example * * // BEFORE RUNNING: * // --------------- @@ -59889,7 +61902,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.deleteInstances - * @desc Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. (== suppress_warning http-rest-shadowed ==) + * @desc Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @example * * // BEFORE RUNNING: * // --------------- @@ -60025,9 +62038,88 @@ export namespace compute_beta { } } + /** + * compute.regionInstanceGroupManagers.deletePerInstanceConfigs + * @desc Deletes selected per-instance configs for the managed instance group. + * @alias compute.regionInstanceGroupManagers.deletePerInstanceConfigs + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroupManager The name of the managed instance group. It should conform to RFC1035. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request, should conform to RFC1035. + * @param {().RegionInstanceGroupManagerDeleteInstanceConfigReq} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + deletePerInstanceConfigs( + params?: Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs, + options?: MethodOptions + ): GaxiosPromise; + deletePerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deletePerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs, + callback: BodyResponseCallback + ): void; + deletePerInstanceConfigs( + callback: BodyResponseCallback + ): void; + deletePerInstanceConfigs( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * compute.regionInstanceGroupManagers.get - * @desc Returns all of the details about the specified managed instance group. (== suppress_warning http-rest-shadowed ==) + * @desc Returns all of the details about the specified managed instance group. * @example * * // BEFORE RUNNING: * // --------------- @@ -60161,7 +62253,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.insert - * @desc Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A regional managed instance group can contain up to 2000 instances. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A regional managed instance group can contain up to 2000 instances. * @example * * // BEFORE RUNNING: * // --------------- @@ -60295,7 +62387,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.list - * @desc Retrieves the list of managed instance groups that are contained within the specified region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of managed instance groups that are contained within the specified region. * @example * * // BEFORE RUNNING: * // --------------- @@ -60447,9 +62539,391 @@ export namespace compute_beta { } } + /** + * compute.regionInstanceGroupManagers.listErrors + * @desc Lists all errors thrown by actions on instances for a given regional managed instance group. + * @alias compute.regionInstanceGroupManagers.listErrors + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {string} params.instanceGroupManager The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)|[1-9][0-9]{0,19}. + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. This should conform to RFC1035. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + listErrors( + params?: Params$Resource$Regioninstancegroupmanagers$Listerrors, + options?: MethodOptions + ): GaxiosPromise; + listErrors( + params: Params$Resource$Regioninstancegroupmanagers$Listerrors, + options: + | MethodOptions + | BodyResponseCallback< + Schema$RegionInstanceGroupManagersListErrorsResponse + >, + callback: BodyResponseCallback< + Schema$RegionInstanceGroupManagersListErrorsResponse + > + ): void; + listErrors( + params: Params$Resource$Regioninstancegroupmanagers$Listerrors, + callback: BodyResponseCallback< + Schema$RegionInstanceGroupManagersListErrorsResponse + > + ): void; + listErrors( + callback: BodyResponseCallback< + Schema$RegionInstanceGroupManagersListErrorsResponse + > + ): void; + listErrors( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Listerrors + | BodyResponseCallback< + Schema$RegionInstanceGroupManagersListErrorsResponse + >, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback< + Schema$RegionInstanceGroupManagersListErrorsResponse + >, + callback?: BodyResponseCallback< + Schema$RegionInstanceGroupManagersListErrorsResponse + > + ): void | GaxiosPromise< + Schema$RegionInstanceGroupManagersListErrorsResponse + > { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Listerrors; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroupmanagers$Listerrors; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listErrors' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest< + Schema$RegionInstanceGroupManagersListErrorsResponse + >(parameters); + } + } + /** * compute.regionInstanceGroupManagers.listManagedInstances - * @desc Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. (== suppress_warning http-rest-shadowed ==) + * @desc Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Compute Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/compute + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * var google = require('googleapis'); + * var compute = google.compute('beta'); + * + * authorize(function(authClient) { + * var request = { + * // Project ID for this request. + * project: 'my-project', // TODO: Update placeholder value. + * + * // Name of the region scoping this request. + * region: 'my-region', // TODO: Update placeholder value. + * + * // The name of the managed instance group. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var managedInstancesPage = response['managedInstances']; + * if (!managedInstancesPage) { + * return; + * } + * for (var i = 0; i < managedInstancesPage.length; i++) { + * // TODO: Change code below to process each resource in `managedInstancesPage`: + * console.log(JSON.stringify(managedInstancesPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * compute.regionInstanceGroupManagers.listManagedInstances(request, handlePage); + * } + * }; + * + * compute.regionInstanceGroupManagers.listManagedInstances(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getApplicationDefault(function(err, authClient) { + * if (err) { + * console.error('authentication failed: ', err); + * return; + * } + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); + * } + * callback(authClient); + * }); + * } + * @alias compute.regionInstanceGroupManagers.listManagedInstances + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {string} params.instanceGroupManager The name of the managed instance group. + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.order_by Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + listManagedInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances, + options?: MethodOptions + ): GaxiosPromise; + listManagedInstances( + params: Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances, + options: + | MethodOptions + | BodyResponseCallback< + Schema$RegionInstanceGroupManagersListInstancesResponse + >, + callback: BodyResponseCallback< + Schema$RegionInstanceGroupManagersListInstancesResponse + > + ): void; + listManagedInstances( + params: Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances, + callback: BodyResponseCallback< + Schema$RegionInstanceGroupManagersListInstancesResponse + > + ): void; + listManagedInstances( + callback: BodyResponseCallback< + Schema$RegionInstanceGroupManagersListInstancesResponse + > + ): void; + listManagedInstances( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances + | BodyResponseCallback< + Schema$RegionInstanceGroupManagersListInstancesResponse + >, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback< + Schema$RegionInstanceGroupManagersListInstancesResponse + >, + callback?: BodyResponseCallback< + Schema$RegionInstanceGroupManagersListInstancesResponse + > + ): void | GaxiosPromise< + Schema$RegionInstanceGroupManagersListInstancesResponse + > { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest< + Schema$RegionInstanceGroupManagersListInstancesResponse + >(parameters, callback); + } else { + return createAPIRequest< + Schema$RegionInstanceGroupManagersListInstancesResponse + >(parameters); + } + } + + /** + * compute.regionInstanceGroupManagers.listPerInstanceConfigs + * @desc Lists all of the per-instance configs defined for the managed instance group. + * @alias compute.regionInstanceGroupManagers.listPerInstanceConfigs + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {string} params.instanceGroupManager The name of the managed instance group. It should conform to RFC1035. + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request, should conform to RFC1035. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + listPerInstanceConfigs( + params?: Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs, + options?: MethodOptions + ): GaxiosPromise; + listPerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs, + options: + | MethodOptions + | BodyResponseCallback< + Schema$RegionInstanceGroupManagersListInstanceConfigsResp + >, + callback: BodyResponseCallback< + Schema$RegionInstanceGroupManagersListInstanceConfigsResp + > + ): void; + listPerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs, + callback: BodyResponseCallback< + Schema$RegionInstanceGroupManagersListInstanceConfigsResp + > + ): void; + listPerInstanceConfigs( + callback: BodyResponseCallback< + Schema$RegionInstanceGroupManagersListInstanceConfigsResp + > + ): void; + listPerInstanceConfigs( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs + | BodyResponseCallback< + Schema$RegionInstanceGroupManagersListInstanceConfigsResp + >, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback< + Schema$RegionInstanceGroupManagersListInstanceConfigsResp + >, + callback?: BodyResponseCallback< + Schema$RegionInstanceGroupManagersListInstanceConfigsResp + > + ): void | GaxiosPromise< + Schema$RegionInstanceGroupManagersListInstanceConfigsResp + > { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest< + Schema$RegionInstanceGroupManagersListInstanceConfigsResp + >(parameters, callback); + } else { + return createAPIRequest< + Schema$RegionInstanceGroupManagersListInstanceConfigsResp + >(parameters); + } + } + + /** + * compute.regionInstanceGroupManagers.patch + * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- @@ -60476,34 +62950,26 @@ export namespace compute_beta { * // Name of the region scoping this request. * region: 'my-region', // TODO: Update placeholder value. * - * // The name of the managed instance group. + * // The name of the instance group manager. * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * * auth: authClient, * }; * - * var handlePage = function(err, response) { + * compute.regionInstanceGroupManagers.patch(request, function(err, response) { * if (err) { * console.error(err); * return; * } * - * var managedInstancesPage = response['managedInstances']; - * if (!managedInstancesPage) { - * return; - * } - * for (var i = 0; i < managedInstancesPage.length; i++) { - * // TODO: Change code below to process each resource in `managedInstancesPage`: - * console.log(JSON.stringify(managedInstancesPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * compute.regionInstanceGroupManagers.listManagedInstances(request, handlePage); - * } - * }; - * - * compute.regionInstanceGroupManagers.listManagedInstances(request, handlePage); + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); * }); * * function authorize(callback) { @@ -60519,71 +62985,49 @@ export namespace compute_beta { * callback(authClient); * }); * } - * @alias compute.regionInstanceGroupManagers.listManagedInstances + * @alias compute.regionInstanceGroupManagers.patch * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). - * @param {string} params.instanceGroupManager The name of the managed instance group. - * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) - * @param {string=} params.order_by Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. - * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.instanceGroupManager The name of the instance group manager. * @param {string} params.project Project ID for this request. * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().InstanceGroupManager} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - listManagedInstances( - params?: Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances, + patch( + params?: Params$Resource$Regioninstancegroupmanagers$Patch, options?: MethodOptions - ): GaxiosPromise; - listManagedInstances( - params: Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances, - options: - | MethodOptions - | BodyResponseCallback< - Schema$RegionInstanceGroupManagersListInstancesResponse - >, - callback: BodyResponseCallback< - Schema$RegionInstanceGroupManagersListInstancesResponse - > - ): void; - listManagedInstances( - params: Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances, - callback: BodyResponseCallback< - Schema$RegionInstanceGroupManagersListInstancesResponse - > + ): GaxiosPromise; + patch( + params: Params$Resource$Regioninstancegroupmanagers$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listManagedInstances( - callback: BodyResponseCallback< - Schema$RegionInstanceGroupManagersListInstancesResponse - > + patch( + params: Params$Resource$Regioninstancegroupmanagers$Patch, + callback: BodyResponseCallback ): void; - listManagedInstances( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances - | BodyResponseCallback< - Schema$RegionInstanceGroupManagersListInstancesResponse - >, + | Params$Resource$Regioninstancegroupmanagers$Patch + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback< - Schema$RegionInstanceGroupManagersListInstancesResponse - >, - callback?: BodyResponseCallback< - Schema$RegionInstanceGroupManagersListInstancesResponse - > - ): void | GaxiosPromise< - Schema$RegionInstanceGroupManagersListInstancesResponse - > { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances; + {}) as Params$Resource$Regioninstancegroupmanagers$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances; + params = {} as Params$Resource$Regioninstancegroupmanagers$Patch; options = {}; } @@ -60598,9 +63042,9 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PATCH', }, options ), @@ -60610,110 +63054,47 @@ export namespace compute_beta { context: this.context, }; if (callback) { - createAPIRequest< - Schema$RegionInstanceGroupManagersListInstancesResponse - >(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest< - Schema$RegionInstanceGroupManagersListInstancesResponse - >(parameters); + return createAPIRequest(parameters); } } /** - * compute.regionInstanceGroupManagers.patch - * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Compute Engine API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more information, see - * // https://developers.google.com/identity/protocols/application-default-credentials - * // 3. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var compute = google.compute('beta'); - * - * authorize(function(authClient) { - * var request = { - * // Project ID for this request. - * project: 'my-project', // TODO: Update placeholder value. - * - * // Name of the region scoping this request. - * region: 'my-region', // TODO: Update placeholder value. - * - * // The name of the instance group manager. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * compute.regionInstanceGroupManagers.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); - * }); - * } - * @alias compute.regionInstanceGroupManagers.patch + * compute.regionInstanceGroupManagers.patchPerInstanceConfigs + * @desc Insert or patch (for the ones that already exist) per-instance configs for the managed instance group. perInstanceConfig.instance serves as a key used to distinguish whether to perform insert or patch. + * @alias compute.regionInstanceGroupManagers.patchPerInstanceConfigs * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.instanceGroupManager The name of the instance group manager. + * @param {string} params.instanceGroupManager The name of the managed instance group. It should conform to RFC1035. * @param {string} params.project Project ID for this request. - * @param {string} params.region Name of the region scoping this request. + * @param {string} params.region Name of the region scoping this request, should conform to 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 {().InstanceGroupManager} params.requestBody Request body data + * @param {().RegionInstanceGroupManagerPatchInstanceConfigReq} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - patch( - params?: Params$Resource$Regioninstancegroupmanagers$Patch, + patchPerInstanceConfigs( + params?: Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs, options?: MethodOptions ): GaxiosPromise; - patch( - params: Params$Resource$Regioninstancegroupmanagers$Patch, + patchPerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Regioninstancegroupmanagers$Patch, + patchPerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs, callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + patchPerInstanceConfigs( + callback: BodyResponseCallback + ): void; + patchPerInstanceConfigs( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Patch + | Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs | BodyResponseCallback, optionsOrCallback?: | MethodOptions @@ -60721,12 +63102,12 @@ export namespace compute_beta { callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Patch; + {}) as Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Patch; + params = {} as Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs; options = {}; } @@ -60741,9 +63122,9 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'POST', }, options ), @@ -60761,7 +63142,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.recreateInstances - * @desc Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. (== suppress_warning http-rest-shadowed ==) + * @desc Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @example * * // BEFORE RUNNING: * // --------------- @@ -60899,7 +63280,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.resize - * @desc Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. (== suppress_warning http-rest-shadowed ==) + * @desc Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. * @example * * // BEFORE RUNNING: * // --------------- @@ -61036,7 +63417,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.setAutoHealingPolicies - * @desc Modifies the autohealing policy for the instances in this managed instance group. [Deprecated] This method is deprecated. Please use Patch instead. (== suppress_warning http-rest-shadowed ==) + * @desc Modifies the autohealing policy for the instances in this managed instance group. [Deprecated] This method is deprecated. Please use Patch instead. * @example * * // BEFORE RUNNING: * // --------------- @@ -61176,7 +63557,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.setInstanceTemplate - * @desc Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected. * @example * * // BEFORE RUNNING: * // --------------- @@ -61314,7 +63695,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.setTargetPools - * @desc Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected. (== suppress_warning http-rest-shadowed ==) + * @desc Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected. * @example * * // BEFORE RUNNING: * // --------------- @@ -61452,7 +63833,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -61593,7 +63974,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.update - * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method. (== suppress_warning http-rest-shadowed ==) + * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method. * @example * * // BEFORE RUNNING: * // --------------- @@ -61729,6 +64110,86 @@ export namespace compute_beta { return createAPIRequest(parameters); } } + + /** + * compute.regionInstanceGroupManagers.updatePerInstanceConfigs + * @desc Insert or update (for the ones that already exist) per-instance configs for the managed instance group. perInstanceConfig.instance serves as a key used to distinguish whether to perform insert or patch. + * @alias compute.regionInstanceGroupManagers.updatePerInstanceConfigs + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroupManager The name of the managed instance group. It should conform to RFC1035. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request, should conform to 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 {().RegionInstanceGroupManagerUpdateInstanceConfigReq} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + updatePerInstanceConfigs( + params?: Params$Resource$Regioninstancegroupmanagers$Updateperinstanceconfigs, + options?: MethodOptions + ): GaxiosPromise; + updatePerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Updateperinstanceconfigs, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updatePerInstanceConfigs( + params: Params$Resource$Regioninstancegroupmanagers$Updateperinstanceconfigs, + callback: BodyResponseCallback + ): void; + updatePerInstanceConfigs( + callback: BodyResponseCallback + ): void; + updatePerInstanceConfigs( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Updateperinstanceconfigs + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Updateperinstanceconfigs; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroupmanagers$Updateperinstanceconfigs; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Regioninstancegroupmanagers$Abandoninstances @@ -61867,6 +64328,31 @@ export namespace compute_beta { */ requestBody?: Schema$RegionInstanceGroupManagersDeleteInstancesRequest; } + export interface Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the managed instance group. It should conform to RFC1035. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request, should conform to RFC1035. + */ + region?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupManagerDeleteInstanceConfigReq; + } export interface Params$Resource$Regioninstancegroupmanagers$Get extends StandardParameters { /** @@ -61944,6 +64430,42 @@ export namespace compute_beta { */ region?: string; } + export interface Params$Resource$Regioninstancegroupmanagers$Listerrors + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)|[1-9][0-9]{0,19}. + */ + instanceGroupManager?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. This should conform to RFC1035. + */ + region?: string; + } export interface Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances extends StandardParameters { /** @@ -61980,6 +64502,42 @@ export namespace compute_beta { */ region?: string; } + export interface Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The name of the managed instance group. It should conform to RFC1035. + */ + instanceGroupManager?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request, should conform to RFC1035. + */ + region?: string; + } export interface Params$Resource$Regioninstancegroupmanagers$Patch extends StandardParameters { /** @@ -62009,6 +64567,35 @@ export namespace compute_beta { */ requestBody?: Schema$InstanceGroupManager; } + export interface Params$Resource$Regioninstancegroupmanagers$Patchperinstanceconfigs + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the managed instance group. It should conform to RFC1035. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request, should conform to RFC1035. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupManagerPatchInstanceConfigReq; + } export interface Params$Resource$Regioninstancegroupmanagers$Recreateinstances extends StandardParameters { /** @@ -62207,6 +64794,35 @@ export namespace compute_beta { */ requestBody?: Schema$InstanceGroupManager; } + export interface Params$Resource$Regioninstancegroupmanagers$Updateperinstanceconfigs + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the managed instance group. It should conform to RFC1035. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request, should conform to RFC1035. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupManagerUpdateInstanceConfigReq; + } export class Resource$Regioninstancegroups { context: APIRequestContext; @@ -62216,7 +64832,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroups.get - * @desc Returns the specified instance group resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified instance group resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -62348,7 +64964,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroups.list - * @desc Retrieves the list of instance group resources contained within the specified region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of instance group resources contained within the specified region. * @example * * // BEFORE RUNNING: * // --------------- @@ -62495,7 +65111,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroups.listInstances - * @desc Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. (== suppress_warning http-rest-shadowed ==) + * @desc Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. * @example * * // BEFORE RUNNING: * // --------------- @@ -62658,7 +65274,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroups.setNamedPorts - * @desc Sets the named ports for the specified regional instance group. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the named ports for the specified regional instance group. * @example * * // BEFORE RUNNING: * // --------------- @@ -62796,7 +65412,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroups.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -63092,7 +65708,7 @@ export namespace compute_beta { /** * compute.regionOperations.delete - * @desc Deletes the specified region-specific Operations resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified region-specific Operations resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -63219,7 +65835,7 @@ export namespace compute_beta { /** * compute.regionOperations.get - * @desc Retrieves the specified region-specific Operations resource. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the specified region-specific Operations resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -63351,7 +65967,7 @@ export namespace compute_beta { /** * compute.regionOperations.list - * @desc Retrieves a list of Operation resources contained within the specified region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of Operation resources contained within the specified region. * @example * * // BEFORE RUNNING: * // --------------- @@ -63493,6 +66109,82 @@ export namespace compute_beta { return createAPIRequest(parameters); } } + + /** + * compute.regionOperations.wait + * @desc Waits for the specified region-specific Operations resource until it is done or timeout, and retrieves the specified Operations resource. 1. Immediately returns when the operation is already done. 2. Waits for no more than the default deadline (2 minutes, subject to change) and then returns the current state of the operation, which may be DONE or still in progress. 3. Is best-effort: a. The server can wait less than the default deadline or zero seconds, in overload situations. b. There is no guarantee that the operation is actually done when returns. 4. User should be prepared to retry if the operation is not DONE. + * @alias compute.regionOperations.wait + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.operation Name of the Operations resource to return. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + wait( + params?: Params$Resource$Regionoperations$Wait, + options?: MethodOptions + ): GaxiosPromise; + wait( + params: Params$Resource$Regionoperations$Wait, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Regionoperations$Wait, + callback: BodyResponseCallback + ): void; + wait(callback: BodyResponseCallback): void; + wait( + paramsOrCallback?: + | Params$Resource$Regionoperations$Wait + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionoperations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionoperations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/operations/{operation}/wait' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'operation'], + pathParams: ['operation', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Regionoperations$Delete @@ -63567,6 +66259,26 @@ export namespace compute_beta { */ region?: string; } + export interface Params$Resource$Regionoperations$Wait + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the Operations resource to return. + */ + operation?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + } export class Resource$Regions { context: APIRequestContext; @@ -63576,7 +66288,7 @@ export namespace compute_beta { /** * compute.regions.get - * @desc Returns the specified Region resource. Gets a list of available regions by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified Region resource. Gets a list of available regions by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -63700,7 +66412,7 @@ export namespace compute_beta { /** * compute.regions.list - * @desc Retrieves the list of region resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of region resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -63890,7 +66602,7 @@ export namespace compute_beta { /** * compute.regionSslCertificates.delete - * @desc Deletes the specified SslCertificate resource in the region. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified SslCertificate resource in the region. * @alias compute.regionSslCertificates.delete * @memberOf! () * @@ -63967,7 +66679,7 @@ export namespace compute_beta { /** * compute.regionSslCertificates.get - * @desc Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request. * @alias compute.regionSslCertificates.get * @memberOf! () * @@ -64043,7 +66755,7 @@ export namespace compute_beta { /** * compute.regionSslCertificates.insert - * @desc Creates a SslCertificate resource in the specified project and region using the data included in the request (== suppress_warning http-rest-shadowed ==) + * @desc Creates a SslCertificate resource in the specified project and region using the data included in the request * @alias compute.regionSslCertificates.insert * @memberOf! () * @@ -64120,7 +66832,7 @@ export namespace compute_beta { /** * compute.regionSslCertificates.list - * @desc Retrieves the list of SslCertificate resources available to the specified project in the specified region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of SslCertificate resources available to the specified project in the specified region. * @alias compute.regionSslCertificates.list * @memberOf! () * @@ -64308,7 +67020,7 @@ export namespace compute_beta { /** * compute.regionTargetHttpProxies.delete - * @desc Deletes the specified TargetHttpProxy resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified TargetHttpProxy resource. * @alias compute.regionTargetHttpProxies.delete * @memberOf! () * @@ -64385,7 +67097,7 @@ export namespace compute_beta { /** * compute.regionTargetHttpProxies.get - * @desc Returns the specified TargetHttpProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified TargetHttpProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request. * @alias compute.regionTargetHttpProxies.get * @memberOf! () * @@ -64461,7 +67173,7 @@ export namespace compute_beta { /** * compute.regionTargetHttpProxies.insert - * @desc Creates a TargetHttpProxy resource in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a TargetHttpProxy resource in the specified project and region using the data included in the request. * @alias compute.regionTargetHttpProxies.insert * @memberOf! () * @@ -64538,7 +67250,7 @@ export namespace compute_beta { /** * compute.regionTargetHttpProxies.list - * @desc Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region. * @alias compute.regionTargetHttpProxies.list * @memberOf! () * @@ -64617,7 +67329,7 @@ export namespace compute_beta { /** * compute.regionTargetHttpProxies.setUrlMap - * @desc Changes the URL map for TargetHttpProxy. (== suppress_warning http-rest-shadowed ==) + * @desc Changes the URL map for TargetHttpProxy. * @alias compute.regionTargetHttpProxies.setUrlMap * @memberOf! () * @@ -64833,7 +67545,7 @@ export namespace compute_beta { /** * compute.regionTargetHttpsProxies.delete - * @desc Deletes the specified TargetHttpsProxy resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified TargetHttpsProxy resource. * @alias compute.regionTargetHttpsProxies.delete * @memberOf! () * @@ -64910,7 +67622,7 @@ export namespace compute_beta { /** * compute.regionTargetHttpsProxies.get - * @desc Returns the specified TargetHttpsProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified TargetHttpsProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request. * @alias compute.regionTargetHttpsProxies.get * @memberOf! () * @@ -64986,7 +67698,7 @@ export namespace compute_beta { /** * compute.regionTargetHttpsProxies.insert - * @desc Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request. * @alias compute.regionTargetHttpsProxies.insert * @memberOf! () * @@ -65063,7 +67775,7 @@ export namespace compute_beta { /** * compute.regionTargetHttpsProxies.list - * @desc Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region. * @alias compute.regionTargetHttpsProxies.list * @memberOf! () * @@ -65144,7 +67856,7 @@ export namespace compute_beta { /** * compute.regionTargetHttpsProxies.setSslCertificates - * @desc Replaces SslCertificates for TargetHttpsProxy. (== suppress_warning http-rest-shadowed ==) + * @desc Replaces SslCertificates for TargetHttpsProxy. * @alias compute.regionTargetHttpsProxies.setSslCertificates * @memberOf! () * @@ -65222,7 +67934,7 @@ export namespace compute_beta { /** * compute.regionTargetHttpsProxies.setUrlMap - * @desc Changes the URL map for TargetHttpsProxy. (== suppress_warning http-rest-shadowed ==) + * @desc Changes the URL map for TargetHttpsProxy. * @alias compute.regionTargetHttpsProxies.setUrlMap * @memberOf! () * @@ -65467,7 +68179,7 @@ export namespace compute_beta { /** * compute.regionUrlMaps.delete - * @desc Deletes the specified UrlMap resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified UrlMap resource. * @alias compute.regionUrlMaps.delete * @memberOf! () * @@ -65544,7 +68256,7 @@ export namespace compute_beta { /** * compute.regionUrlMaps.get - * @desc Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request. * @alias compute.regionUrlMaps.get * @memberOf! () * @@ -65618,7 +68330,7 @@ export namespace compute_beta { /** * compute.regionUrlMaps.insert - * @desc Creates a UrlMap resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a UrlMap resource in the specified project using the data included in the request. * @alias compute.regionUrlMaps.insert * @memberOf! () * @@ -65695,7 +68407,7 @@ export namespace compute_beta { /** * compute.regionUrlMaps.invalidateCache - * @desc Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. (== suppress_warning http-rest-shadowed ==) + * @desc Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. * @alias compute.regionUrlMaps.invalidateCache * @memberOf! () * @@ -65773,7 +68485,7 @@ export namespace compute_beta { /** * compute.regionUrlMaps.list - * @desc Retrieves the list of UrlMap resources available to the specified project in the specified region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of UrlMap resources available to the specified project in the specified region. * @alias compute.regionUrlMaps.list * @memberOf! () * @@ -65852,7 +68564,7 @@ export namespace compute_beta { /** * compute.regionUrlMaps.patch - * @desc Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. * @alias compute.regionUrlMaps.patch * @memberOf! () * @@ -65930,7 +68642,7 @@ export namespace compute_beta { /** * compute.regionUrlMaps.update - * @desc Updates the specified UrlMap resource with the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified UrlMap resource with the data included in the request. * @alias compute.regionUrlMaps.update * @memberOf! () * @@ -66008,7 +68720,7 @@ export namespace compute_beta { /** * compute.regionUrlMaps.validate - * @desc Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap. (== suppress_warning http-rest-shadowed ==) + * @desc Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap. * @alias compute.regionUrlMaps.validate * @memberOf! () * @@ -66310,7 +69022,7 @@ export namespace compute_beta { /** * compute.reservations.aggregatedList - * @desc Retrieves an aggregated list of reservations. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of reservations. * @alias compute.reservations.aggregatedList * @memberOf! () * @@ -66395,7 +69107,7 @@ export namespace compute_beta { /** * compute.reservations.delete - * @desc Deletes the specified reservation. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified reservation. * @alias compute.reservations.delete * @memberOf! () * @@ -66472,7 +69184,7 @@ export namespace compute_beta { /** * compute.reservations.get - * @desc Retrieves information about the specified reservation. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves information about the specified reservation. * @alias compute.reservations.get * @memberOf! () * @@ -66547,7 +69259,7 @@ export namespace compute_beta { /** * compute.reservations.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.reservations.getIamPolicy * @memberOf! () * @@ -66622,7 +69334,7 @@ export namespace compute_beta { /** * compute.reservations.insert - * @desc Creates a new reservation. For more information, read Reserving zonal resources. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a new reservation. For more information, read Reserving zonal resources. * @alias compute.reservations.insert * @memberOf! () * @@ -66699,7 +69411,7 @@ export namespace compute_beta { /** * compute.reservations.list - * @desc A list of all the reservations that have been configured for the specified project in specified zone. (== suppress_warning http-rest-shadowed ==) + * @desc A list of all the reservations that have been configured for the specified project in specified zone. * @alias compute.reservations.list * @memberOf! () * @@ -66778,7 +69490,7 @@ export namespace compute_beta { /** * compute.reservations.resize - * @desc Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations. (== suppress_warning http-rest-shadowed ==) + * @desc Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations. * @alias compute.reservations.resize * @memberOf! () * @@ -66856,7 +69568,7 @@ export namespace compute_beta { /** * compute.reservations.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.reservations.setIamPolicy * @memberOf! () * @@ -66931,7 +69643,7 @@ export namespace compute_beta { /** * compute.reservations.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.reservations.testIamPermissions * @memberOf! () * @@ -67251,7 +69963,7 @@ export namespace compute_beta { /** * compute.resourcePolicies.aggregatedList - * @desc Retrieves an aggregated list of resource policies. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of resource policies. * @alias compute.resourcePolicies.aggregatedList * @memberOf! () * @@ -67338,7 +70050,7 @@ export namespace compute_beta { /** * compute.resourcePolicies.delete - * @desc Deletes the specified resource policy. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified resource policy. * @alias compute.resourcePolicies.delete * @memberOf! () * @@ -67415,7 +70127,7 @@ export namespace compute_beta { /** * compute.resourcePolicies.get - * @desc Retrieves all information of the specified resource policy. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves all information of the specified resource policy. * @alias compute.resourcePolicies.get * @memberOf! () * @@ -67491,7 +70203,7 @@ export namespace compute_beta { /** * compute.resourcePolicies.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.resourcePolicies.getIamPolicy * @memberOf! () * @@ -67566,7 +70278,7 @@ export namespace compute_beta { /** * compute.resourcePolicies.insert - * @desc Creates a new resource policy. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a new resource policy. * @alias compute.resourcePolicies.insert * @memberOf! () * @@ -67643,7 +70355,7 @@ export namespace compute_beta { /** * compute.resourcePolicies.list - * @desc A list all the resource policies that have been configured for the specified project in specified region. (== suppress_warning http-rest-shadowed ==) + * @desc A list all the resource policies that have been configured for the specified project in specified region. * @alias compute.resourcePolicies.list * @memberOf! () * @@ -67722,7 +70434,7 @@ export namespace compute_beta { /** * compute.resourcePolicies.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.resourcePolicies.setIamPolicy * @memberOf! () * @@ -67797,7 +70509,7 @@ export namespace compute_beta { /** * compute.resourcePolicies.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.resourcePolicies.testIamPermissions * @memberOf! () * @@ -68089,7 +70801,7 @@ export namespace compute_beta { /** * compute.routers.aggregatedList - * @desc Retrieves an aggregated list of routers. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of routers. * @example * * // BEFORE RUNNING: * // --------------- @@ -68233,7 +70945,7 @@ export namespace compute_beta { /** * compute.routers.delete - * @desc Deletes the specified Router resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified Router resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -68365,7 +71077,7 @@ export namespace compute_beta { /** * compute.routers.get - * @desc Returns the specified Router resource. Gets a list of available routers by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified Router resource. Gets a list of available routers by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -68494,7 +71206,7 @@ export namespace compute_beta { /** * compute.routers.getNatMappingInfo - * @desc Retrieves runtime Nat mapping information of VM endpoints. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves runtime Nat mapping information of VM endpoints. * @alias compute.routers.getNatMappingInfo * @memberOf! () * @@ -68582,7 +71294,7 @@ export namespace compute_beta { /** * compute.routers.getRouterStatus - * @desc Retrieves runtime information of the specified router. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves runtime information of the specified router. * @example * * // BEFORE RUNNING: * // --------------- @@ -68718,7 +71430,7 @@ export namespace compute_beta { /** * compute.routers.insert - * @desc Creates a Router resource in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a Router resource in the specified project and region using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -68851,7 +71563,7 @@ export namespace compute_beta { /** * compute.routers.list - * @desc Retrieves a list of Router resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of Router resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -68995,7 +71707,7 @@ export namespace compute_beta { /** * compute.routers.patch - * @desc Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- @@ -69133,7 +71845,7 @@ export namespace compute_beta { /** * compute.routers.preview - * @desc Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router. (== suppress_warning http-rest-shadowed ==) + * @desc Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router. * @example * * // BEFORE RUNNING: * // --------------- @@ -69273,7 +71985,7 @@ export namespace compute_beta { /** * compute.routers.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -69414,7 +72126,7 @@ export namespace compute_beta { /** * compute.routers.update - * @desc Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload. * @example * * // BEFORE RUNNING: * // --------------- @@ -69850,7 +72562,7 @@ export namespace compute_beta { /** * compute.routes.delete - * @desc Deletes the specified Route resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified Route resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -69977,7 +72689,7 @@ export namespace compute_beta { /** * compute.routes.get - * @desc Returns the specified Route resource. Gets a list of available routes by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified Route resource. Gets a list of available routes by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -70101,7 +72813,7 @@ export namespace compute_beta { /** * compute.routes.insert - * @desc Creates a Route resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a Route resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -70229,7 +72941,7 @@ export namespace compute_beta { /** * compute.routes.list - * @desc Retrieves the list of Route resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of Route resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -70368,7 +73080,7 @@ export namespace compute_beta { /** * compute.routes.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -70615,7 +73327,7 @@ export namespace compute_beta { /** * compute.securityPolicies.addRule - * @desc Inserts a rule into a security policy. (== suppress_warning http-rest-shadowed ==) + * @desc Inserts a rule into a security policy. * @alias compute.securityPolicies.addRule * @memberOf! () * @@ -70692,7 +73404,7 @@ export namespace compute_beta { /** * compute.securityPolicies.delete - * @desc Deletes the specified policy. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified policy. * @example * * // BEFORE RUNNING: * // --------------- @@ -70821,7 +73533,7 @@ export namespace compute_beta { /** * compute.securityPolicies.get - * @desc List all of the ordered rules present in a single specified policy. (== suppress_warning http-rest-shadowed ==) + * @desc List all of the ordered rules present in a single specified policy. * @example * * // BEFORE RUNNING: * // --------------- @@ -70949,7 +73661,7 @@ export namespace compute_beta { /** * compute.securityPolicies.getRule - * @desc Gets a rule at the specified priority. (== suppress_warning http-rest-shadowed ==) + * @desc Gets a rule at the specified priority. * @alias compute.securityPolicies.getRule * @memberOf! () * @@ -71025,7 +73737,7 @@ export namespace compute_beta { /** * compute.securityPolicies.insert - * @desc Creates a new policy in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a new policy in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -71156,7 +73868,7 @@ export namespace compute_beta { /** * compute.securityPolicies.list - * @desc List all the policies that have been configured for the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc List all the policies that have been configured for the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -71297,7 +74009,7 @@ export namespace compute_beta { /** * compute.securityPolicies.listPreconfiguredExpressionSets - * @desc Gets the current list of preconfigured Web Application Firewall (WAF) expressions. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the current list of preconfigured Web Application Firewall (WAF) expressions. * @alias compute.securityPolicies.listPreconfiguredExpressionSets * @memberOf! () * @@ -71401,7 +74113,7 @@ export namespace compute_beta { /** * compute.securityPolicies.patch - * @desc Patches the specified policy with the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Patches the specified policy with the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -71536,7 +74248,7 @@ export namespace compute_beta { /** * compute.securityPolicies.patchRule - * @desc Patches a rule at the specified priority. (== suppress_warning http-rest-shadowed ==) + * @desc Patches a rule at the specified priority. * @alias compute.securityPolicies.patchRule * @memberOf! () * @@ -71614,7 +74326,7 @@ export namespace compute_beta { /** * compute.securityPolicies.removeRule - * @desc Deletes a rule at the specified priority. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes a rule at the specified priority. * @alias compute.securityPolicies.removeRule * @memberOf! () * @@ -71690,7 +74402,7 @@ export namespace compute_beta { /** * compute.securityPolicies.setLabels - * @desc Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation. * @alias compute.securityPolicies.setLabels * @memberOf! () * @@ -71766,7 +74478,7 @@ export namespace compute_beta { /** * compute.securityPolicies.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -72189,7 +74901,7 @@ export namespace compute_beta { /** * compute.snapshots.delete - * @desc Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snapshots. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snapshots. * @example * * // BEFORE RUNNING: * // --------------- @@ -72317,7 +75029,7 @@ export namespace compute_beta { /** * compute.snapshots.get - * @desc Returns the specified Snapshot resource. Gets a list of available snapshots by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified Snapshot resource. Gets a list of available snapshots by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -72442,7 +75154,7 @@ export namespace compute_beta { /** * compute.snapshots.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.snapshots.getIamPolicy * @memberOf! () * @@ -72516,7 +75228,7 @@ export namespace compute_beta { /** * compute.snapshots.list - * @desc Retrieves the list of Snapshot resources contained within the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of Snapshot resources contained within the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -72655,7 +75367,7 @@ export namespace compute_beta { /** * compute.snapshots.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.snapshots.setIamPolicy * @memberOf! () * @@ -72729,7 +75441,7 @@ export namespace compute_beta { /** * compute.snapshots.setLabels - * @desc Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation. * @example * * // BEFORE RUNNING: * // --------------- @@ -72862,7 +75574,7 @@ export namespace compute_beta { /** * compute.snapshots.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -73151,7 +75863,7 @@ export namespace compute_beta { /** * compute.sslCertificates.aggregatedList - * @desc Retrieves the list of all SslCertificate resources, regional and global, available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of all SslCertificate resources, regional and global, available to the specified project. * @alias compute.sslCertificates.aggregatedList * @memberOf! () * @@ -73238,7 +75950,7 @@ export namespace compute_beta { /** * compute.sslCertificates.delete - * @desc Deletes the specified SslCertificate resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified SslCertificate resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -73367,7 +76079,7 @@ export namespace compute_beta { /** * compute.sslCertificates.get - * @desc Returns the specified SslCertificate resource. Gets a list of available SSL certificates by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified SslCertificate resource. Gets a list of available SSL certificates by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -73495,7 +76207,7 @@ export namespace compute_beta { /** * compute.sslCertificates.insert - * @desc Creates a SslCertificate resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a SslCertificate resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -73625,7 +76337,7 @@ export namespace compute_beta { /** * compute.sslCertificates.list - * @desc Retrieves the list of SslCertificate resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of SslCertificate resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -73766,7 +76478,7 @@ export namespace compute_beta { /** * compute.sslCertificates.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -74045,7 +76757,7 @@ export namespace compute_beta { /** * compute.sslPolicies.delete - * @desc Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources. * @alias compute.sslPolicies.delete * @memberOf! () * @@ -74121,7 +76833,7 @@ export namespace compute_beta { /** * compute.sslPolicies.get - * @desc Lists all of the ordered rules present in a single specified policy. (== suppress_warning http-rest-shadowed ==) + * @desc Lists all of the ordered rules present in a single specified policy. * @alias compute.sslPolicies.get * @memberOf! () * @@ -74195,7 +76907,7 @@ export namespace compute_beta { /** * compute.sslPolicies.insert - * @desc Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() request. * @alias compute.sslPolicies.insert * @memberOf! () * @@ -74270,7 +76982,7 @@ export namespace compute_beta { /** * compute.sslPolicies.list - * @desc Lists all the SSL policies that have been configured for the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Lists all the SSL policies that have been configured for the specified project. * @alias compute.sslPolicies.list * @memberOf! () * @@ -74346,7 +77058,7 @@ export namespace compute_beta { /** * compute.sslPolicies.listAvailableFeatures - * @desc Lists all features that can be specified in the SSL policy when using custom profile. (== suppress_warning http-rest-shadowed ==) + * @desc Lists all features that can be specified in the SSL policy when using custom profile. * @alias compute.sslPolicies.listAvailableFeatures * @memberOf! () * @@ -74441,7 +77153,7 @@ export namespace compute_beta { /** * compute.sslPolicies.patch - * @desc Patches the specified SSL policy with the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Patches the specified SSL policy with the data included in the request. * @alias compute.sslPolicies.patch * @memberOf! () * @@ -74518,7 +77230,7 @@ export namespace compute_beta { /** * compute.sslPolicies.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.sslPolicies.testIamPermissions * @memberOf! () * @@ -74763,7 +77475,7 @@ export namespace compute_beta { /** * compute.subnetworks.aggregatedList - * @desc Retrieves an aggregated list of subnetworks. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of subnetworks. * @example * * // BEFORE RUNNING: * // --------------- @@ -74908,7 +77620,7 @@ export namespace compute_beta { /** * compute.subnetworks.delete - * @desc Deletes the specified subnetwork. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified subnetwork. * @example * * // BEFORE RUNNING: * // --------------- @@ -75041,7 +77753,7 @@ export namespace compute_beta { /** * compute.subnetworks.expandIpCidrRange - * @desc Expands the IP CIDR range of the subnetwork to a specified value. (== suppress_warning http-rest-shadowed ==) + * @desc Expands the IP CIDR range of the subnetwork to a specified value. * @example * * // BEFORE RUNNING: * // --------------- @@ -75179,7 +77891,7 @@ export namespace compute_beta { /** * compute.subnetworks.get - * @desc Returns the specified subnetwork. Gets a list of available subnetworks list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified subnetwork. Gets a list of available subnetworks list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -75310,7 +78022,7 @@ export namespace compute_beta { /** * compute.subnetworks.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @example * * // BEFORE RUNNING: * // --------------- @@ -75441,7 +78153,7 @@ export namespace compute_beta { /** * compute.subnetworks.insert - * @desc Creates a subnetwork in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a subnetwork in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -75575,7 +78287,7 @@ export namespace compute_beta { /** * compute.subnetworks.list - * @desc Retrieves a list of subnetworks available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of subnetworks available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -75719,7 +78431,7 @@ export namespace compute_beta { /** * compute.subnetworks.listUsable - * @desc Retrieves an aggregated list of all usable subnetworks in the project. The list contains all of the subnetworks in the project and the subnetworks that were shared by a Shared VPC host project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of all usable subnetworks in the project. The list contains all of the subnetworks in the project and the subnetworks that were shared by a Shared VPC host project. * @alias compute.subnetworks.listUsable * @memberOf! () * @@ -75806,7 +78518,7 @@ export namespace compute_beta { /** * compute.subnetworks.patch - * @desc Patches the specified subnetwork with the data included in the request. Only certain fields can up updated with a patch request as indicated in the field descriptions. You must specify the current fingeprint of the subnetwork resource being patched. (== suppress_warning http-rest-shadowed ==) + * @desc Patches the specified subnetwork with the data included in the request. Only certain fields can up updated with a patch request as indicated in the field descriptions. You must specify the current fingeprint of the subnetwork resource being patched. * @example * * // BEFORE RUNNING: * // --------------- @@ -75946,7 +78658,7 @@ export namespace compute_beta { /** * compute.subnetworks.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @example * * // BEFORE RUNNING: * // --------------- @@ -76081,7 +78793,7 @@ export namespace compute_beta { /** * compute.subnetworks.setPrivateIpGoogleAccess - * @desc Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access. (== suppress_warning http-rest-shadowed ==) + * @desc Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access. * @example * * // BEFORE RUNNING: * // --------------- @@ -76221,7 +78933,7 @@ export namespace compute_beta { /** * compute.subnetworks.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -76690,7 +79402,7 @@ export namespace compute_beta { /** * compute.targetHttpProxies.aggregatedList - * @desc Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project. * @alias compute.targetHttpProxies.aggregatedList * @memberOf! () * @@ -76777,7 +79489,7 @@ export namespace compute_beta { /** * compute.targetHttpProxies.delete - * @desc Deletes the specified TargetHttpProxy resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified TargetHttpProxy resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -76906,7 +79618,7 @@ export namespace compute_beta { /** * compute.targetHttpProxies.get - * @desc Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -77034,7 +79746,7 @@ export namespace compute_beta { /** * compute.targetHttpProxies.insert - * @desc Creates a TargetHttpProxy resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a TargetHttpProxy resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -77164,7 +79876,7 @@ export namespace compute_beta { /** * compute.targetHttpProxies.list - * @desc Retrieves the list of TargetHttpProxy resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of TargetHttpProxy resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -77305,7 +80017,7 @@ export namespace compute_beta { /** * compute.targetHttpProxies.setUrlMap - * @desc Changes the URL map for TargetHttpProxy. (== suppress_warning http-rest-shadowed ==) + * @desc Changes the URL map for TargetHttpProxy. * @example * * // BEFORE RUNNING: * // --------------- @@ -77439,7 +80151,7 @@ export namespace compute_beta { /** * compute.targetHttpProxies.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -77743,7 +80455,7 @@ export namespace compute_beta { /** * compute.targetHttpsProxies.aggregatedList - * @desc Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project. * @alias compute.targetHttpsProxies.aggregatedList * @memberOf! () * @@ -77830,7 +80542,7 @@ export namespace compute_beta { /** * compute.targetHttpsProxies.delete - * @desc Deletes the specified TargetHttpsProxy resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified TargetHttpsProxy resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -77959,7 +80671,7 @@ export namespace compute_beta { /** * compute.targetHttpsProxies.get - * @desc Returns the specified TargetHttpsProxy resource. Gets a list of available target HTTPS proxies by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified TargetHttpsProxy resource. Gets a list of available target HTTPS proxies by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -78087,7 +80799,7 @@ export namespace compute_beta { /** * compute.targetHttpsProxies.insert - * @desc Creates a TargetHttpsProxy resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a TargetHttpsProxy resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -78217,7 +80929,7 @@ export namespace compute_beta { /** * compute.targetHttpsProxies.list - * @desc Retrieves the list of TargetHttpsProxy resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of TargetHttpsProxy resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -78360,7 +81072,7 @@ export namespace compute_beta { /** * compute.targetHttpsProxies.setQuicOverride - * @desc Sets the QUIC override policy for TargetHttpsProxy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the QUIC override policy for TargetHttpsProxy. * @alias compute.targetHttpsProxies.setQuicOverride * @memberOf! () * @@ -78437,7 +81149,7 @@ export namespace compute_beta { /** * compute.targetHttpsProxies.setSslCertificates - * @desc Replaces SslCertificates for TargetHttpsProxy. (== suppress_warning http-rest-shadowed ==) + * @desc Replaces SslCertificates for TargetHttpsProxy. * @example * * // BEFORE RUNNING: * // --------------- @@ -78571,7 +81283,7 @@ export namespace compute_beta { /** * compute.targetHttpsProxies.setSslPolicy - * @desc Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends. * @alias compute.targetHttpsProxies.setSslPolicy * @memberOf! () * @@ -78648,7 +81360,7 @@ export namespace compute_beta { /** * compute.targetHttpsProxies.setUrlMap - * @desc Changes the URL map for TargetHttpsProxy. (== suppress_warning http-rest-shadowed ==) + * @desc Changes the URL map for TargetHttpsProxy. * @example * * // BEFORE RUNNING: * // --------------- @@ -78782,7 +81494,7 @@ export namespace compute_beta { /** * compute.targetHttpsProxies.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -79161,7 +81873,7 @@ export namespace compute_beta { /** * compute.targetInstances.aggregatedList - * @desc Retrieves an aggregated list of target instances. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of target instances. * @example * * // BEFORE RUNNING: * // --------------- @@ -79311,7 +82023,7 @@ export namespace compute_beta { /** * compute.targetInstances.delete - * @desc Deletes the specified TargetInstance resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified TargetInstance resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -79444,7 +82156,7 @@ export namespace compute_beta { /** * compute.targetInstances.get - * @desc Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -79576,7 +82288,7 @@ export namespace compute_beta { /** * compute.targetInstances.insert - * @desc Creates a TargetInstance resource in the specified project and zone using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a TargetInstance resource in the specified project and zone using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -79710,7 +82422,7 @@ export namespace compute_beta { /** * compute.targetInstances.list - * @desc Retrieves a list of TargetInstance resources available to the specified project and zone. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of TargetInstance resources available to the specified project and zone. * @example * * // BEFORE RUNNING: * // --------------- @@ -79855,7 +82567,7 @@ export namespace compute_beta { /** * compute.targetInstances.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -80158,7 +82870,7 @@ export namespace compute_beta { /** * compute.targetPools.addHealthCheck - * @desc Adds health check URLs to a target pool. (== suppress_warning http-rest-shadowed ==) + * @desc Adds health check URLs to a target pool. * @example * * // BEFORE RUNNING: * // --------------- @@ -80296,7 +83008,7 @@ export namespace compute_beta { /** * compute.targetPools.addInstance - * @desc Adds an instance to a target pool. (== suppress_warning http-rest-shadowed ==) + * @desc Adds an instance to a target pool. * @example * * // BEFORE RUNNING: * // --------------- @@ -80434,7 +83146,7 @@ export namespace compute_beta { /** * compute.targetPools.aggregatedList - * @desc Retrieves an aggregated list of target pools. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of target pools. * @example * * // BEFORE RUNNING: * // --------------- @@ -80579,7 +83291,7 @@ export namespace compute_beta { /** * compute.targetPools.delete - * @desc Deletes the specified target pool. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified target pool. * @example * * // BEFORE RUNNING: * // --------------- @@ -80712,7 +83424,7 @@ export namespace compute_beta { /** * compute.targetPools.get - * @desc Returns the specified target pool. Gets a list of available target pools by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified target pool. Gets a list of available target pools by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -80843,7 +83555,7 @@ export namespace compute_beta { /** * compute.targetPools.getHealth - * @desc Gets the most recent health check results for each IP for the instance that is referenced by the given target pool. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the most recent health check results for each IP for the instance that is referenced by the given target pool. * @example * * // BEFORE RUNNING: * // --------------- @@ -80984,7 +83696,7 @@ export namespace compute_beta { /** * compute.targetPools.insert - * @desc Creates a target pool in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a target pool in the specified project and region using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -81118,7 +83830,7 @@ export namespace compute_beta { /** * compute.targetPools.list - * @desc Retrieves a list of target pools available to the specified project and region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of target pools available to the specified project and region. * @example * * // BEFORE RUNNING: * // --------------- @@ -81262,7 +83974,7 @@ export namespace compute_beta { /** * compute.targetPools.removeHealthCheck - * @desc Removes health check URL from a target pool. (== suppress_warning http-rest-shadowed ==) + * @desc Removes health check URL from a target pool. * @example * * // BEFORE RUNNING: * // --------------- @@ -81400,7 +84112,7 @@ export namespace compute_beta { /** * compute.targetPools.removeInstance - * @desc Removes instance URL from a target pool. (== suppress_warning http-rest-shadowed ==) + * @desc Removes instance URL from a target pool. * @example * * // BEFORE RUNNING: * // --------------- @@ -81538,7 +84250,7 @@ export namespace compute_beta { /** * compute.targetPools.setBackup - * @desc Changes a backup target pool's configurations. (== suppress_warning http-rest-shadowed ==) + * @desc Changes a backup target pool's configurations. * @example * * // BEFORE RUNNING: * // --------------- @@ -81677,7 +84389,7 @@ export namespace compute_beta { /** * compute.targetPools.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -82152,7 +84864,7 @@ export namespace compute_beta { /** * compute.targetSslProxies.delete - * @desc Deletes the specified TargetSslProxy resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified TargetSslProxy resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -82281,7 +84993,7 @@ export namespace compute_beta { /** * compute.targetSslProxies.get - * @desc Returns the specified TargetSslProxy resource. Gets a list of available target SSL proxies by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified TargetSslProxy resource. Gets a list of available target SSL proxies by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -82409,7 +85121,7 @@ export namespace compute_beta { /** * compute.targetSslProxies.insert - * @desc Creates a TargetSslProxy resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a TargetSslProxy resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -82539,7 +85251,7 @@ export namespace compute_beta { /** * compute.targetSslProxies.list - * @desc Retrieves the list of TargetSslProxy resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of TargetSslProxy resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -82680,7 +85392,7 @@ export namespace compute_beta { /** * compute.targetSslProxies.setBackendService - * @desc Changes the BackendService for TargetSslProxy. (== suppress_warning http-rest-shadowed ==) + * @desc Changes the BackendService for TargetSslProxy. * @example * * // BEFORE RUNNING: * // --------------- @@ -82814,7 +85526,7 @@ export namespace compute_beta { /** * compute.targetSslProxies.setProxyHeader - * @desc Changes the ProxyHeaderType for TargetSslProxy. (== suppress_warning http-rest-shadowed ==) + * @desc Changes the ProxyHeaderType for TargetSslProxy. * @example * * // BEFORE RUNNING: * // --------------- @@ -82948,7 +85660,7 @@ export namespace compute_beta { /** * compute.targetSslProxies.setSslCertificates - * @desc Changes SslCertificates for TargetSslProxy. (== suppress_warning http-rest-shadowed ==) + * @desc Changes SslCertificates for TargetSslProxy. * @example * * // BEFORE RUNNING: * // --------------- @@ -83082,7 +85794,7 @@ export namespace compute_beta { /** * compute.targetSslProxies.setSslPolicy - * @desc Sets the SSL policy for TargetSslProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the SSL proxy load balancer. They do not affect the connection between the load balancer and the backends. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the SSL policy for TargetSslProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the SSL proxy load balancer. They do not affect the connection between the load balancer and the backends. * @alias compute.targetSslProxies.setSslPolicy * @memberOf! () * @@ -83159,7 +85871,7 @@ export namespace compute_beta { /** * compute.targetSslProxies.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -83510,7 +86222,7 @@ export namespace compute_beta { /** * compute.targetTcpProxies.delete - * @desc Deletes the specified TargetTcpProxy resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified TargetTcpProxy resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -83639,7 +86351,7 @@ export namespace compute_beta { /** * compute.targetTcpProxies.get - * @desc Returns the specified TargetTcpProxy resource. Gets a list of available target TCP proxies by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified TargetTcpProxy resource. Gets a list of available target TCP proxies by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -83767,7 +86479,7 @@ export namespace compute_beta { /** * compute.targetTcpProxies.insert - * @desc Creates a TargetTcpProxy resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a TargetTcpProxy resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -83897,7 +86609,7 @@ export namespace compute_beta { /** * compute.targetTcpProxies.list - * @desc Retrieves the list of TargetTcpProxy resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of TargetTcpProxy resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -84038,7 +86750,7 @@ export namespace compute_beta { /** * compute.targetTcpProxies.setBackendService - * @desc Changes the BackendService for TargetTcpProxy. (== suppress_warning http-rest-shadowed ==) + * @desc Changes the BackendService for TargetTcpProxy. * @example * * // BEFORE RUNNING: * // --------------- @@ -84172,7 +86884,7 @@ export namespace compute_beta { /** * compute.targetTcpProxies.setProxyHeader - * @desc Changes the ProxyHeaderType for TargetTcpProxy. (== suppress_warning http-rest-shadowed ==) + * @desc Changes the ProxyHeaderType for TargetTcpProxy. * @example * * // BEFORE RUNNING: * // --------------- @@ -84449,7 +87161,7 @@ export namespace compute_beta { /** * compute.targetVpnGateways.aggregatedList - * @desc Retrieves an aggregated list of target VPN gateways. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of target VPN gateways. * @example * * // BEFORE RUNNING: * // --------------- @@ -84599,7 +87311,7 @@ export namespace compute_beta { /** * compute.targetVpnGateways.delete - * @desc Deletes the specified target VPN gateway. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified target VPN gateway. * @example * * // BEFORE RUNNING: * // --------------- @@ -84732,7 +87444,7 @@ export namespace compute_beta { /** * compute.targetVpnGateways.get - * @desc Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -84864,7 +87576,7 @@ export namespace compute_beta { /** * compute.targetVpnGateways.insert - * @desc Creates a target VPN gateway in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a target VPN gateway in the specified project and region using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -84998,7 +87710,7 @@ export namespace compute_beta { /** * compute.targetVpnGateways.list - * @desc Retrieves a list of target VPN gateways available to the specified project and region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of target VPN gateways available to the specified project and region. * @example * * // BEFORE RUNNING: * // --------------- @@ -85145,7 +87857,7 @@ export namespace compute_beta { /** * compute.targetVpnGateways.setLabels - * @desc Sets the labels on a TargetVpnGateway. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the labels on a TargetVpnGateway. To learn more about labels, read the Labeling Resources documentation. * @alias compute.targetVpnGateways.setLabels * @memberOf! () * @@ -85223,7 +87935,7 @@ export namespace compute_beta { /** * compute.targetVpnGateways.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -85555,7 +88267,7 @@ export namespace compute_beta { /** * compute.urlMaps.aggregatedList - * @desc Retrieves the list of all UrlMap resources, regional and global, available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of all UrlMap resources, regional and global, available to the specified project. * @alias compute.urlMaps.aggregatedList * @memberOf! () * @@ -85636,7 +88348,7 @@ export namespace compute_beta { /** * compute.urlMaps.delete - * @desc Deletes the specified UrlMap resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified UrlMap resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -85764,7 +88476,7 @@ export namespace compute_beta { /** * compute.urlMaps.get - * @desc Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -85889,7 +88601,7 @@ export namespace compute_beta { /** * compute.urlMaps.insert - * @desc Creates a UrlMap resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a UrlMap resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -86017,7 +88729,7 @@ export namespace compute_beta { /** * compute.urlMaps.invalidateCache - * @desc Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. (== suppress_warning http-rest-shadowed ==) + * @desc Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. * @example * * // BEFORE RUNNING: * // --------------- @@ -86151,7 +88863,7 @@ export namespace compute_beta { /** * compute.urlMaps.list - * @desc Retrieves the list of UrlMap resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of UrlMap resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -86290,7 +89002,7 @@ export namespace compute_beta { /** * compute.urlMaps.patch - * @desc Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- @@ -86424,7 +89136,7 @@ export namespace compute_beta { /** * compute.urlMaps.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -86561,7 +89273,7 @@ export namespace compute_beta { /** * compute.urlMaps.update - * @desc Updates the specified UrlMap resource with the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified UrlMap resource with the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -86695,7 +89407,7 @@ export namespace compute_beta { /** * compute.urlMaps.validate - * @desc Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap. (== suppress_warning http-rest-shadowed ==) + * @desc Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap. * @example * * // BEFORE RUNNING: * // --------------- @@ -87062,7 +89774,7 @@ export namespace compute_beta { /** * compute.vpnGateways.aggregatedList - * @desc Retrieves an aggregated list of VPN gateways. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of VPN gateways. * @alias compute.vpnGateways.aggregatedList * @memberOf! () * @@ -87144,7 +89856,7 @@ export namespace compute_beta { /** * compute.vpnGateways.delete - * @desc Deletes the specified VPN gateway. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified VPN gateway. * @alias compute.vpnGateways.delete * @memberOf! () * @@ -87221,7 +89933,7 @@ export namespace compute_beta { /** * compute.vpnGateways.get - * @desc Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request. * @alias compute.vpnGateways.get * @memberOf! () * @@ -87296,7 +90008,7 @@ export namespace compute_beta { /** * compute.vpnGateways.getStatus - * @desc Returns the status for the specified VPN gateway. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the status for the specified VPN gateway. * @alias compute.vpnGateways.getStatus * @memberOf! () * @@ -87381,7 +90093,7 @@ export namespace compute_beta { /** * compute.vpnGateways.insert - * @desc Creates a VPN gateway in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a VPN gateway in the specified project and region using the data included in the request. * @alias compute.vpnGateways.insert * @memberOf! () * @@ -87458,7 +90170,7 @@ export namespace compute_beta { /** * compute.vpnGateways.list - * @desc Retrieves a list of VPN gateways available to the specified project and region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of VPN gateways available to the specified project and region. * @alias compute.vpnGateways.list * @memberOf! () * @@ -87536,7 +90248,7 @@ export namespace compute_beta { /** * compute.vpnGateways.setLabels - * @desc Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation. * @alias compute.vpnGateways.setLabels * @memberOf! () * @@ -87798,7 +90510,7 @@ export namespace compute_beta { /** * compute.vpnTunnels.aggregatedList - * @desc Retrieves an aggregated list of VPN tunnels. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of VPN tunnels. * @example * * // BEFORE RUNNING: * // --------------- @@ -87942,7 +90654,7 @@ export namespace compute_beta { /** * compute.vpnTunnels.delete - * @desc Deletes the specified VpnTunnel resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified VpnTunnel resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -88075,7 +90787,7 @@ export namespace compute_beta { /** * compute.vpnTunnels.get - * @desc Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -88206,7 +90918,7 @@ export namespace compute_beta { /** * compute.vpnTunnels.insert - * @desc Creates a VpnTunnel resource in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a VpnTunnel resource in the specified project and region using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -88340,7 +91052,7 @@ export namespace compute_beta { /** * compute.vpnTunnels.list - * @desc Retrieves a list of VpnTunnel resources contained in the specified project and region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of VpnTunnel resources contained in the specified project and region. * @example * * // BEFORE RUNNING: * // --------------- @@ -88484,7 +91196,7 @@ export namespace compute_beta { /** * compute.vpnTunnels.setLabels - * @desc Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources documentation. * @alias compute.vpnTunnels.setLabels * @memberOf! () * @@ -88562,7 +91274,7 @@ export namespace compute_beta { /** * compute.vpnTunnels.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -88892,7 +91604,7 @@ export namespace compute_beta { /** * compute.zoneOperations.delete - * @desc Deletes the specified zone-specific Operations resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified zone-specific Operations resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -89019,7 +91731,7 @@ export namespace compute_beta { /** * compute.zoneOperations.get - * @desc Retrieves the specified zone-specific Operations resource. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the specified zone-specific Operations resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -89151,7 +91863,7 @@ export namespace compute_beta { /** * compute.zoneOperations.list - * @desc Retrieves a list of Operation resources contained within the specified zone. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of Operation resources contained within the specified zone. * @example * * // BEFORE RUNNING: * // --------------- @@ -89293,6 +92005,82 @@ export namespace compute_beta { return createAPIRequest(parameters); } } + + /** + * compute.zoneOperations.wait + * @desc Waits for the specified zone-specific Operations resource until it is done or timeout, and retrieves the specified Operations resource. 1. Immediately returns when the operation is already done. 2. Waits for no more than the default deadline (2 minutes, subject to change) and then returns the current state of the operation, which may be DONE or still in progress. 3. Is best-effort: a. The server can wait less than the default deadline or zero seconds, in overload situations. b. There is no guarantee that the operation is actually done when returns. 4. User should be prepared to retry if the operation is not DONE. + * @alias compute.zoneOperations.wait + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.operation Name of the Operations resource to return. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone Name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + wait( + params?: Params$Resource$Zoneoperations$Wait, + options?: MethodOptions + ): GaxiosPromise; + wait( + params: Params$Resource$Zoneoperations$Wait, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Zoneoperations$Wait, + callback: BodyResponseCallback + ): void; + wait(callback: BodyResponseCallback): void; + wait( + paramsOrCallback?: + | Params$Resource$Zoneoperations$Wait + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Zoneoperations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Zoneoperations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/operations/{operation}/wait' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'operation'], + pathParams: ['operation', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Zoneoperations$Delete @@ -89367,6 +92155,26 @@ export namespace compute_beta { */ zone?: string; } + export interface Params$Resource$Zoneoperations$Wait + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the Operations resource to return. + */ + operation?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the zone for this request. + */ + zone?: string; + } export class Resource$Zones { context: APIRequestContext; @@ -89376,7 +92184,7 @@ export namespace compute_beta { /** * compute.zones.get - * @desc Returns the specified Zone resource. Gets a list of available zones by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified Zone resource. Gets a list of available zones by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -89500,7 +92308,7 @@ export namespace compute_beta { /** * compute.zones.list - * @desc Retrieves the list of Zone resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of Zone resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- diff --git a/src/apis/compute/v1.ts b/src/apis/compute/v1.ts index 69a6536d6cf..b5009d0b7ab 100644 --- a/src/apis/compute/v1.ts +++ b/src/apis/compute/v1.ts @@ -700,7 +700,7 @@ export namespace compute_v1 { */ diskName?: string | null; /** - * Specifies the size of the disk in base-2 GB. If not specified, the disk will be the same size as the image (usually 10GB). If specified, the size must be equal to or larger than 10GB. + * Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB. */ diskSizeGb?: string | null; /** @@ -797,6 +797,10 @@ export namespace compute_v1 { * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string | null; + /** + * [Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates recommended MIG size even when autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to the existing managed instance group or autoscaler did not generate its prediction. + */ + recommendedSize?: number | null; /** * [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope). */ @@ -806,7 +810,7 @@ export namespace compute_v1 { */ selfLink?: string | null; /** - * [Output Only] The status of the autoscaler configuration. Current set of possible values: PENDING: Autoscaler backend hasn't read new/updated configuration DELETING: Configuration is being deleted ACTIVE: Configuration is acknowledged to be effective. Some warnings might or might not be present in the status_details field. ERROR: Configuration has errors. Actionable for users. Details are present in the status_details field. New values might be added in the future. + * [Output Only] The status of the autoscaler configuration. Current set of possible values: - PENDING: Autoscaler backend hasn't read new/updated configuration. - DELETING: Configuration is being deleted. - ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field. - ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future. */ status?: string | null; /** @@ -905,7 +909,7 @@ export namespace compute_v1 { */ message?: string | null; /** - * The type of error, warning or notice returned. Current set of possible values: ALL_INSTANCES_UNHEALTHY (WARNING): All instances in the instance group are unhealthy (not in RUNNING state). BACKEND_SERVICE_DOES_NOT_EXIST (ERROR): There is no backend service attached to the instance group. CAPPED_AT_MAX_NUM_REPLICAS (WARNING): Autoscaler recommends size bigger than maxNumReplicas. CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE (WARNING): The custom metric samples are not exported often enough to be a credible base for autoscaling. CUSTOM_METRIC_INVALID (ERROR): The custom metric that was specified does not exist or does not have the necessary labels. MIN_EQUALS_MAX (WARNING): The minNumReplicas is equal to maxNumReplicas. This means the autoscaler cannot add or remove instances from the instance group. MISSING_CUSTOM_METRIC_DATA_POINTS (WARNING): The autoscaler did not receive any data from the custom metric configured for autoscaling. MISSING_LOAD_BALANCING_DATA_POINTS (WARNING): The autoscaler is configured to scale based on a load balancing signal but the instance group has not received any requests from the load balancer. MODE_OFF (WARNING): Autoscaling is turned off. The number of instances in the group won't change automatically. The autoscaling configuration is preserved. MODE_ONLY_UP (WARNING): Autoscaling is in the "Autoscale only up" mode. Instances in the group will be only added. MORE_THAN_ONE_BACKEND_SERVICE (ERROR): The instance group cannot be autoscaled because it has more than one backend service attached to it. NOT_ENOUGH_QUOTA_AVAILABLE (ERROR): Exceeded quota for necessary resources, such as CPU, number of instances and so on. REGION_RESOURCE_STOCKOUT (ERROR): Showed only for regional autoscalers: there is a resource stockout in the chosen region. SCALING_TARGET_DOES_NOT_EXIST (ERROR): The target to be scaled does not exist. UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION (ERROR): Autoscaling does not work with an HTTP/S load balancer that has been configured for maxRate. ZONE_RESOURCE_STOCKOUT (ERROR): For zonal autoscalers: there is a resource stockout in the chosen zone. For regional autoscalers: in at least one of the zones you're using there is a resource stockout. New values might be added in the future. Some of the values might not be available in all API versions. + * The type of error, warning, or notice returned. Current set of possible values: - ALL_INSTANCES_UNHEALTHY (WARNING): All instances in the instance group are unhealthy (not in RUNNING state). - BACKEND_SERVICE_DOES_NOT_EXIST (ERROR): There is no backend service attached to the instance group. - CAPPED_AT_MAX_NUM_REPLICAS (WARNING): Autoscaler recommends a size greater than maxNumReplicas. - CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE (WARNING): The custom metric samples are not exported often enough to be a credible base for autoscaling. - CUSTOM_METRIC_INVALID (ERROR): The custom metric that was specified does not exist or does not have the necessary labels. - MIN_EQUALS_MAX (WARNING): The minNumReplicas is equal to maxNumReplicas. This means the autoscaler cannot add or remove instances from the instance group. - MISSING_CUSTOM_METRIC_DATA_POINTS (WARNING): The autoscaler did not receive any data from the custom metric configured for autoscaling. - MISSING_LOAD_BALANCING_DATA_POINTS (WARNING): The autoscaler is configured to scale based on a load balancing signal but the instance group has not received any requests from the load balancer. - MODE_OFF (WARNING): Autoscaling is turned off. The number of instances in the group won't change automatically. The autoscaling configuration is preserved. - MODE_ONLY_UP (WARNING): Autoscaling is in the "Autoscale only up" mode. The autoscaler can add instances but not remove any. - MORE_THAN_ONE_BACKEND_SERVICE (ERROR): The instance group cannot be autoscaled because it has more than one backend service attached to it. - NOT_ENOUGH_QUOTA_AVAILABLE (ERROR): There is insufficient quota for the necessary resources, such as CPU or number of instances. - REGION_RESOURCE_STOCKOUT (ERROR): Shown only for regional autoscalers: there is a resource stockout in the chosen region. - SCALING_TARGET_DOES_NOT_EXIST (ERROR): The target to be scaled does not exist. - UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION (ERROR): Autoscaling does not work with an HTTP/S load balancer that has been configured for maxRate. - ZONE_RESOURCE_STOCKOUT (ERROR): For zonal autoscalers: there is a resource stockout in the chosen zone. For regional autoscalers: in at least one of the zones you're using there is a resource stockout. New values might be added in the future. Some of the values might not be available in all API versions. */ type?: string | null; } @@ -937,6 +941,10 @@ export namespace compute_v1 { * The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed. */ minNumReplicas?: number | null; + /** + * Defines operating mode for this policy. + */ + mode?: string | null; } /** * CPU utilization policy. @@ -1172,7 +1180,7 @@ export namespace compute_v1 { */ loadBalancingScheme?: string | null; /** - * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. + * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. If sessionAffinity is not NONE, and this field is not set to >MAGLEV or RING_HASH, session affinity settings will not take effect. */ localityLbPolicy?: string | null; /** @@ -1208,7 +1216,7 @@ export namespace compute_v1 { */ selfLink?: string | null; /** - * Type of session affinity to use. The default is NONE. Session affinity is not applicable if the --protocol is UDP. When the loadBalancingScheme is EXTERNAL, possible values are NONE, CLIENT_IP, or GENERATED_COOKIE. You can use GENERATED_COOKIE if the protocol is HTTP or HTTPS. When the loadBalancingScheme is INTERNAL, possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. When the loadBalancingScheme is INTERNAL_SELF_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE. + * Type of session affinity to use. The default is NONE. Session affinity is not applicable if the --protocol is UDP. When the loadBalancingScheme is EXTERNAL, possible values are NONE, CLIENT_IP, or GENERATED_COOKIE. You can use GENERATED_COOKIE if the protocol is HTTP or HTTPS. When the loadBalancingScheme is INTERNAL, possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. When the loadBalancingScheme is INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE. */ sessionAffinity?: string | null; /** @@ -1347,7 +1355,7 @@ export namespace compute_v1 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example,`alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -2118,6 +2126,58 @@ export namespace compute_v1 { */ seconds?: string | null; } + export interface Schema$ExchangedPeeringRoute { + /** + * The destination range of the route. + */ + destRange?: string | null; + /** + * True if the peering route has been imported from a peer. The actual import happens if the field networkPeering.importCustomRoutes is true for this network, and networkPeering.exportCustomRoutes is true for the peer network, and the import does not result in a route conflict. + */ + imported?: boolean | null; + /** + * The region of peering route next hop, only applies to dynamic routes. + */ + nextHopRegion?: string | null; + /** + * The priority of the peering route. + */ + priority?: number | null; + /** + * The type of the peering route. + */ + type?: string | null; + } + export interface Schema$ExchangedPeeringRoutesList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of ExchangedPeeringRoute resources. + */ + items?: Schema$ExchangedPeeringRoute[]; + /** + * [Output Only] Type of resource. Always compute#exchangedPeeringRoutesList for exchanged peering routes lists. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } /** * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ @@ -2400,7 +2460,7 @@ export namespace compute_v1 { */ IPAddress?: string | null; /** - * The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP. For Internal TCP/UDP Load Balancing, the load balancing scheme is INTERNAL, and one of TCP or UDP are valid. For Traffic Director, the load balancing scheme is INTERNAL_SELF_MANAGED, and only TCPis valid. For Internal HTTP(S) Load Balancing, the load balancing scheme is INTERNAL_MANAGED, and only TCP is valid. For HTTP(S), SSL Proxy, and TCP Proxy Load Balancing, the load balancing scheme is EXTERNAL and only TCP is valid. For Network TCP/UDP Load Balancing, the load balancing scheme is EXTERNAL, and one of TCP or UDP is valid. + * The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP or ICMP. For Internal TCP/UDP Load Balancing, the load balancing scheme is INTERNAL, and one of TCP or UDP are valid. For Traffic Director, the load balancing scheme is INTERNAL_SELF_MANAGED, and only TCPis valid. For Internal HTTP(S) Load Balancing, the load balancing scheme is INTERNAL_MANAGED, and only TCP is valid. For HTTP(S), SSL Proxy, and TCP Proxy Load Balancing, the load balancing scheme is EXTERNAL and only TCP is valid. For Network TCP/UDP Load Balancing, the load balancing scheme is EXTERNAL, and one of TCP or UDP is valid. */ IPProtocol?: string | null; /** @@ -2416,7 +2476,7 @@ export namespace compute_v1 { */ loadBalancingScheme?: string | null; /** - * Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. metadataFilters specified here can be overridden by those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. + * Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule will not be visible to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. metadataFilters specified here will be applifed before those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. */ metadataFilters?: Schema$MetadataFilter[]; /** @@ -2432,11 +2492,11 @@ export namespace compute_v1 { */ networkTier?: string | null; /** - * This field is deprecated. See the port field. + * When the load balancing scheme is EXTERNAL, INTERNAL_SELF_MANAGED and INTERNAL_MANAGED, you can specify a port_range. Use with a forwarding rule that points to a target proxy or a target pool. Do not use with a forwarding rule that points to a backend service. This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges. Some types of forwarding target have constraints on the acceptable ports: - TargetHttpProxy: 80, 8080 - TargetHttpsProxy: 443 - TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 - TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 - TargetVpnGateway: 500, 4500 */ portRange?: string | null; /** - * List of comma-separated ports. The forwarding rule forwards packets with matching destination ports. If the forwarding rule's loadBalancingScheme is EXTERNAL, and the forwarding rule references a target pool, specifying ports is optional. You can specify an unlimited number of ports, but they must be contiguous. If you omit ports, GCP forwards traffic on any port of the forwarding rule's protocol. If the forwarding rule's loadBalancingScheme is EXTERNAL, and the forwarding rule references a target HTTP proxy, target HTTPS proxy, target TCP proxy, target SSL proxy, or target VPN gateway, you must specify ports using the following constraints: - TargetHttpProxy: 80, 8080 - TargetHttpsProxy: 443 - TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 - TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 - TargetVpnGateway: 500, 4500 If the forwarding rule's loadBalancingScheme is INTERNAL, you must specify ports in one of the following ways: * A list of up to five ports, which can be non-contiguous * Keyword ALL, which causes the forwarding rule to forward traffic on any port of the forwarding rule's protocol. The ports field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. Applicable only when IPProtocol is TCP, UDP, or SCTP. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges. + * This field is used along with the backend_service field for internal load balancing. When the load balancing scheme is INTERNAL, a list of ports can be configured, for example, ['80'], ['8000','9000']. Only packets addressed to these ports are forwarded to the backends configured with the forwarding rule. If the forwarding rule's loadBalancingScheme is INTERNAL, you can specify ports in one of the following ways: * A list of up to five ports, which can be non-contiguous * Keyword ALL, which causes the forwarding rule to forward traffic on any port of the forwarding rule's protocol. */ ports?: string[] | null; /** @@ -2577,7 +2637,7 @@ export namespace compute_v1 { */ kind?: string | null; /** - * The path to be queried. This can be the default namespace ('/') or a nested namespace ('//') or a specified key ('//') + * The path to be queried. This can be the default namespace ('/') or a nested namespace ('/\/') or a specified key ('/\/\') */ queryPath?: string | null; /** @@ -2934,7 +2994,7 @@ export namespace compute_v1 { */ prefixMatch?: string | null; /** - * A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value or not. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. + * A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. */ presentMatch?: boolean | null; /** @@ -3092,7 +3152,7 @@ export namespace compute_v1 { */ export interface Schema$HttpQueryParameterMatch { /** - * The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch and regexMatch must be set. + * The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch or regexMatch must be set. */ exactMatch?: string | null; /** @@ -3100,11 +3160,11 @@ export namespace compute_v1 { */ name?: string | null; /** - * Specifies that the queryParameterMatch matches if the request contains the query parameter, irrespective of whether the parameter has a value or not. Only one of presentMatch, exactMatch and regexMatch must be set. + * Specifies that the queryParameterMatch matches if the request contains the query parameter, irrespective of whether the parameter has a value or not. Only one of presentMatch, exactMatch or regexMatch must be set. */ presentMatch?: boolean | null; /** - * The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch, exactMatch and regexMatch must be set. + * The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch, exactMatch or regexMatch must be set. */ regexMatch?: string | null; } @@ -3176,7 +3236,7 @@ export namespace compute_v1 { */ timeout?: Schema$Duration; /** - * The spec to modify the URL of the request, prior to forwarding the request to the matched service + * The spec to modify the URL of the request, prior to forwarding the request to the matched service. */ urlRewrite?: Schema$UrlRewrite; /** @@ -3202,7 +3262,7 @@ export namespace compute_v1 { */ priority?: number | null; /** - * In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. + * In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. */ routeAction?: Schema$HttpRouteAction; /** @@ -3219,7 +3279,7 @@ export namespace compute_v1 { */ export interface Schema$HttpRouteRuleMatch { /** - * For satifying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL. FullPathMatch must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified. + * For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL. fullPathMatch must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified. */ fullPathMatch?: string | null; /** @@ -3227,15 +3287,15 @@ export namespace compute_v1 { */ headerMatches?: Schema$HttpHeaderMatch[]; /** - * Specifies that prefixMatch and fullPathMatch matches are case sensitive. The default value is false. caseSensitive must not be used with regexMatch. + * Specifies that prefixMatch and fullPathMatch matches are case sensitive. The default value is false. ignoreCase must not be used with regexMatch. */ ignoreCase?: boolean | null; /** - * Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. metadataFilters specified here can be overrides those specified in ForwardingRule that refers to this UrlMap. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. + * Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. */ metadataFilters?: Schema$MetadataFilter[]; /** - * For satifying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. The value must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified. + * For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. The value must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified. */ prefixMatch?: string | null; /** @@ -3243,7 +3303,7 @@ export namespace compute_v1 { */ queryParameterMatches?: Schema$HttpQueryParameterMatch[]; /** - * For satifying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript Only one of prefixMatch, fullPathMatch or regexMatch must be specified. + * For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript Only one of prefixMatch, fullPathMatch or regexMatch must be specified. */ regexMatch?: string | null; } @@ -3487,6 +3547,10 @@ export namespace compute_v1 { * [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY. */ status?: string | null; + /** + * Cloud Storage bucket storage location of the image (regional or multi-regional). + */ + storageLocations?: string[] | null; } /** * Contains a list of images. @@ -3667,7 +3731,7 @@ export namespace compute_v1 { } | null; } /** - * Represents an unmanaged Instance Group resource. Use unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. For more information, read Instance groups. For zonal unmanaged Instance Group, use instanceGroups resource. For regional unmanaged Instance Group, use regionInstanceGroups resource. (== resource_for beta.instanceGroups ==) (== resource_for v1.instanceGroups ==) (== resource_for beta.regionInstanceGroups ==) (== resource_for v1.regionInstanceGroups ==) + * Represents an Instance Group resource. Instance Groups can be used to configure a target for load balancing. Instance groups can either be managed or unmanaged. To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead. Use zonal unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. You cannot create regional unmanaged instance groups. For more information, read Instance groups. (== resource_for beta.instanceGroups ==) (== resource_for v1.instanceGroups ==) (== resource_for beta.regionInstanceGroups ==) (== resource_for v1.regionInstanceGroups ==) */ export interface Schema$InstanceGroup { /** @@ -3992,6 +4056,15 @@ export namespace compute_v1 { */ instances?: string[] | null; } + /** + * InstanceGroupManagers.createInstances + */ + export interface Schema$InstanceGroupManagersCreateInstancesRequest { + /** + * [Required] List of specifications of per-instance configs. + */ + instances?: Schema$PerInstanceConfig[]; + } export interface Schema$InstanceGroupManagersDeleteInstancesRequest { /** * The URLs of one or more instances to delete. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. @@ -4045,8 +4118,22 @@ export namespace compute_v1 { * [Output Only] A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified. */ isStable?: boolean | null; + /** + * [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager. + */ + versionTarget?: Schema$InstanceGroupManagerStatusVersionTarget; + } + export interface Schema$InstanceGroupManagerStatusVersionTarget { + /** + * [Output Only] A bit indicating whether version target has been reached in this managed instance group, i.e. all instances are in their target version. Instances' target version are specified by version field on Instance Group Manager. + */ + isReached?: boolean | null; } export interface Schema$InstanceGroupManagerUpdatePolicy { + /** + * The instance redistribution policy for regional managed instance groups. Valid values are: - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region. - NONE: For non-autoscaled groups, proactive redistribution is disabled. + */ + instanceRedistributionType?: string | null; /** * The maximum number of instances that can be created above the specified targetSize during the update process. By default, a fixed value of 1 is used. This value can be either a fixed number or a percentage if the instance group has 10 or more instances. If you set a percentage, the number of instances will be rounded up if necessary. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge. */ @@ -5427,7 +5514,7 @@ export namespace compute_v1 { kind?: string | null; } /** - * Opaque filter criteria used by loadbalancers to restrict routing configuration to a limited set of loadbalancing proxies. Proxies and sidecars involved in loadbalancing would typically present metadata to the loadbalancers which need to match criteria specified here. If a match takes place, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. An example for using metadataFilters would be: if loadbalancing involves Envoys, they will only receive routing configuration when values in metadataFilters match values supplied in <a href="https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/core/base.proto#envoy-api-msg-core-node" Node metadata of their XDS requests to loadbalancers. + * Opaque filter criteria used by loadbalancers to restrict routing configuration to a limited set of loadbalancing proxies. Proxies and sidecars involved in loadbalancing would typically present metadata to the loadbalancers which need to match criteria specified here. If a match takes place, the relevant configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. An example for using metadataFilters would be: if loadbalancing involves Envoys, they will only receive routing configuration when values in metadataFilters match values supplied in <a href="https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/core/base.proto#envoy-api-msg-core-node" Node metadata of their XDS requests to loadbalancers. */ export interface Schema$MetadataFilter { /** @@ -5498,7 +5585,7 @@ export namespace compute_v1 { */ kind?: string | null; /** - * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. */ name?: string | null; /** @@ -5519,7 +5606,7 @@ export namespace compute_v1 { subnetworks?: string[] | null; } /** - * The network endpoint. + * The network endpoint. Next ID: 7 */ export interface Schema$NetworkEndpoint { /** @@ -5536,7 +5623,7 @@ export namespace compute_v1 { port?: number | null; } /** - * Represents a collection of network endpoints. For more information read Setting up network endpoint groups in load balancing. (== resource_for v1.networkEndpointGroups ==) (== resource_for beta.networkEndpointGroups ==) + * Represents a collection of network endpoints. For more information read Setting up network endpoint groups in load balancing. (== resource_for v1.networkEndpointGroups ==) (== resource_for beta.networkEndpointGroups ==) Next ID: 21 */ export interface Schema$NetworkEndpointGroup { /** @@ -5860,7 +5947,7 @@ export namespace compute_v1 { networkPeering?: Schema$NetworkPeering; } /** - * Represent a sole-tenant Node Group resource. A sole-tenant node is a physical server that is dedicated to hosting VM instances only for your specific project. Use sole-tenant nodes to keep your instances physically separated from instances in other projects, or to group your instances together on the same host hardware. For more information, read Sole-tenant nodes. (== resource_for beta.nodeGroups ==) (== resource_for v1.nodeGroups ==) NextID: 16 + * Represent a sole-tenant Node Group resource. A sole-tenant node is a physical server that is dedicated to hosting VM instances only for your specific project. Use sole-tenant nodes to keep your instances physically separated from instances in other projects, or to group your instances together on the same host hardware. For more information, read Sole-tenant nodes. (== resource_for beta.nodeGroups ==) (== resource_for v1.nodeGroups ==) */ export interface Schema$NodeGroup { /** @@ -6046,7 +6133,7 @@ export namespace compute_v1 { nodeTemplate?: string | null; } /** - * Represent a sole-tenant Node Template resource. You can use a template to define properties for nodes in a node group. For more information, read Creating node groups and instances. (== resource_for beta.nodeTemplates ==) (== resource_for v1.nodeTemplates ==) (== NextID: 16 ==) + * Represent a sole-tenant Node Template resource. You can use a template to define properties for nodes in a node group. For more information, read Creating node groups and instances. (== resource_for beta.nodeTemplates ==) (== resource_for v1.nodeTemplates ==) */ export interface Schema$NodeTemplate { /** @@ -6523,7 +6610,7 @@ export namespace compute_v1 { */ enforcingSuccessRate?: number | null; /** - * Time interval between ejection sweep analysis. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 seconds. + * Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second. */ interval?: Schema$Duration; /** @@ -6556,7 +6643,7 @@ export namespace compute_v1 { */ defaultService?: string | null; /** - * When when none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. + * When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. */ defaultUrlRedirect?: Schema$HttpRedirectAction; /** @@ -6576,7 +6663,7 @@ export namespace compute_v1 { */ pathRules?: Schema$PathRule[]; /** - * The list of ordered HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. The order of specifying routeRules matters: the first rule that matches will cause its specified routing action to take effect. Within a given pathMatcher, only one of pathRules or routeRules must be set. routeRules are not supported in UrlMaps intended for External Load balancers. + * The list of HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number. Within a given pathMatcher, only one of pathRules or routeRules must be set. routeRules are not supported in UrlMaps intended for External Load balancers. */ routeRules?: Schema$HttpRouteRule[]; } @@ -6601,8 +6688,18 @@ export namespace compute_v1 { */ urlRedirect?: Schema$HttpRedirectAction; } + export interface Schema$PerInstanceConfig { + /** + * Fingerprint of this per-instance config. This field may be used in optimistic locking. It will be ignored when inserting a per-instance config. An up-to-date fingerprint must be provided in order to update an existing per-instance config or the field needs to be unset. + */ + fingerprint?: string | null; + /** + * The name of the per-instance config and the corresponding instance. Serves as a merge key during UpdatePerInstanceConfigs operation, i.e. if per-instance config with the same name exists then it will be updated, otherwise a new one will be created for the VM instance with the same name. An attempt to create a per-instance config for a VM instance that either doesn't exist or is not part of the group will result in a failure. + */ + name?: string | null; + } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -6610,11 +6707,11 @@ export namespace compute_v1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if either of incoming or stored policy does not meet the version requirements. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; iamOwned?: boolean | null; @@ -6623,7 +6720,7 @@ export namespace compute_v1 { */ rules?: Schema$Rule[]; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a conditional binding from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, any version compliance checks on the incoming and/or stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } @@ -6962,6 +7059,15 @@ export namespace compute_v1 { */ instances?: string[] | null; } + /** + * RegionInstanceGroupManagers.createInstances + */ + export interface Schema$RegionInstanceGroupManagersCreateInstancesRequest { + /** + * [Required] List of specifications of per-instance configs. + */ + instances?: Schema$PerInstanceConfig[]; + } export interface Schema$RegionInstanceGroupManagersDeleteInstancesRequest { /** * The URLs of one or more instances to delete. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. @@ -8352,7 +8458,7 @@ export namespace compute_v1 { */ export interface Schema$Snapshot { /** - * [Output Only] Set to true if snapshots are automatically by applying resource policy on the target disk. + * [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk. */ autoCreated?: boolean | null; /** @@ -8475,7 +8581,7 @@ export namespace compute_v1 { diskConfigs?: Schema$DiskInstantiationConfig[]; } /** - * Represents an SSL Certificate resource. This SSL certificate resource also contains a private key. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and Using SSL Certificates. (== resource_for beta.sslCertificates ==) (== resource_for v1.sslCertificates ==) + * Represents an SSL Certificate resource. This SSL certificate resource also contains a private key. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and Using SSL Certificates. (== resource_for beta.sslCertificates ==) (== resource_for v1.sslCertificates ==) (== resource_for beta.regionSslCertificates ==) (== resource_for v1.regionSslCertificates ==) Next ID: 17 */ export interface Schema$SslCertificate { /** @@ -8939,7 +9045,7 @@ export namespace compute_v1 { } | null; } /** - * Represents a Target HTTP Proxy resource. A target HTTP proxy is a component of certain types of load balancers. Global forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies. (== resource_for beta.targetHttpProxies ==) (== resource_for v1.targetHttpProxies ==) + * Represents a Target HTTP Proxy resource. A target HTTP proxy is a component of GCP HTTP load balancers. Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for beta.targetHttpProxies ==) (== resource_for v1.targetHttpProxies ==) (== resource_for beta.regionTargetHttpProxies ==) (== resource_for v1.regionTargetHttpProxies ==) */ export interface Schema$TargetHttpProxy { /** @@ -9057,7 +9163,7 @@ export namespace compute_v1 { sslCertificates?: string[] | null; } /** - * Represents a Target HTTPS Proxy resource. A target HTTPS proxy is a component of certain types of load balancers. Global forwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies. (== resource_for beta.targetHttpsProxies ==) (== resource_for v1.targetHttpsProxies ==) + * Represents a Target HTTPS Proxy resource. A target HTTPS proxy is a component of GCP HTTPS load balancers. Forwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for beta.targetHttpsProxies ==) (== resource_for v1.targetHttpsProxies ==) (== resource_for beta.regionTargetHttpsProxies ==) (== resource_for v1.regionTargetHttpsProxies ==) */ export interface Schema$TargetHttpsProxy { /** @@ -10151,7 +10257,7 @@ export namespace compute_v1 { } | null; } /** - * Represents a VPN gateway resource. + * Represents a VPN gateway resource. Next ID: 13 */ export interface Schema$VpnGateway { /** @@ -10690,7 +10796,7 @@ export namespace compute_v1 { /** * compute.acceleratorTypes.aggregatedList - * @desc Retrieves an aggregated list of accelerator types. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of accelerator types. * @example * * // BEFORE RUNNING: * // --------------- @@ -10840,7 +10946,7 @@ export namespace compute_v1 { /** * compute.acceleratorTypes.get - * @desc Returns the specified accelerator type. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified accelerator type. * @example * * // BEFORE RUNNING: * // --------------- @@ -10972,7 +11078,7 @@ export namespace compute_v1 { /** * compute.acceleratorTypes.list - * @desc Retrieves a list of accelerator types available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of accelerator types available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -11205,7 +11311,7 @@ export namespace compute_v1 { /** * compute.addresses.aggregatedList - * @desc Retrieves an aggregated list of addresses. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of addresses. * @example * * // BEFORE RUNNING: * // --------------- @@ -11349,7 +11455,7 @@ export namespace compute_v1 { /** * compute.addresses.delete - * @desc Deletes the specified address resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified address resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -11481,7 +11587,7 @@ export namespace compute_v1 { /** * compute.addresses.get - * @desc Returns the specified address resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified address resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -11610,7 +11716,7 @@ export namespace compute_v1 { /** * compute.addresses.insert - * @desc Creates an address resource in the specified project by using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates an address resource in the specified project by using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -11743,7 +11849,7 @@ export namespace compute_v1 { /** * compute.addresses.list - * @desc Retrieves a list of addresses contained within the specified region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of addresses contained within the specified region. * @example * * // BEFORE RUNNING: * // --------------- @@ -12020,7 +12126,7 @@ export namespace compute_v1 { /** * compute.autoscalers.aggregatedList - * @desc Retrieves an aggregated list of autoscalers. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of autoscalers. * @example * * // BEFORE RUNNING: * // --------------- @@ -12164,7 +12270,7 @@ export namespace compute_v1 { /** * compute.autoscalers.delete - * @desc Deletes the specified autoscaler. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified autoscaler. * @example * * // BEFORE RUNNING: * // --------------- @@ -12297,7 +12403,7 @@ export namespace compute_v1 { /** * compute.autoscalers.get - * @desc Returns the specified autoscaler resource. Gets a list of available autoscalers by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified autoscaler resource. Gets a list of available autoscalers by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -12428,7 +12534,7 @@ export namespace compute_v1 { /** * compute.autoscalers.insert - * @desc Creates an autoscaler in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates an autoscaler in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -12562,7 +12668,7 @@ export namespace compute_v1 { /** * compute.autoscalers.list - * @desc Retrieves a list of autoscalers contained within the specified zone. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of autoscalers contained within the specified zone. * @example * * // BEFORE RUNNING: * // --------------- @@ -12706,7 +12812,7 @@ export namespace compute_v1 { /** * compute.autoscalers.patch - * @desc Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- @@ -12842,7 +12948,7 @@ export namespace compute_v1 { /** * compute.autoscalers.update - * @desc Updates an autoscaler in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Updates an autoscaler in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -13171,7 +13277,7 @@ export namespace compute_v1 { /** * compute.backendBuckets.addSignedUrlKey - * @desc Adds a key for validating requests with signed URLs for this backend bucket. (== suppress_warning http-rest-shadowed ==) + * @desc Adds a key for validating requests with signed URLs for this backend bucket. * @alias compute.backendBuckets.addSignedUrlKey * @memberOf! () * @@ -13248,7 +13354,7 @@ export namespace compute_v1 { /** * compute.backendBuckets.delete - * @desc Deletes the specified BackendBucket resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified BackendBucket resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -13377,7 +13483,7 @@ export namespace compute_v1 { /** * compute.backendBuckets.deleteSignedUrlKey - * @desc Deletes a key for validating requests with signed URLs for this backend bucket. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes a key for validating requests with signed URLs for this backend bucket. * @alias compute.backendBuckets.deleteSignedUrlKey * @memberOf! () * @@ -13454,7 +13560,7 @@ export namespace compute_v1 { /** * compute.backendBuckets.get - * @desc Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -13582,7 +13688,7 @@ export namespace compute_v1 { /** * compute.backendBuckets.insert - * @desc Creates a BackendBucket resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a BackendBucket resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -13711,7 +13817,7 @@ export namespace compute_v1 { /** * compute.backendBuckets.list - * @desc Retrieves the list of BackendBucket resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of BackendBucket resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -13851,7 +13957,7 @@ export namespace compute_v1 { /** * compute.backendBuckets.patch - * @desc Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- @@ -13986,7 +14092,7 @@ export namespace compute_v1 { /** * compute.backendBuckets.update - * @desc Updates the specified BackendBucket resource with the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified BackendBucket resource with the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -14313,7 +14419,7 @@ export namespace compute_v1 { /** * compute.backendServices.addSignedUrlKey - * @desc Adds a key for validating requests with signed URLs for this backend service. (== suppress_warning http-rest-shadowed ==) + * @desc Adds a key for validating requests with signed URLs for this backend service. * @alias compute.backendServices.addSignedUrlKey * @memberOf! () * @@ -14390,7 +14496,7 @@ export namespace compute_v1 { /** * compute.backendServices.aggregatedList - * @desc Retrieves the list of all BackendService resources, regional and global, available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of all BackendService resources, regional and global, available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -14540,7 +14646,7 @@ export namespace compute_v1 { /** * compute.backendServices.delete - * @desc Deletes the specified BackendService resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified BackendService resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -14669,7 +14775,7 @@ export namespace compute_v1 { /** * compute.backendServices.deleteSignedUrlKey - * @desc Deletes a key for validating requests with signed URLs for this backend service. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes a key for validating requests with signed URLs for this backend service. * @alias compute.backendServices.deleteSignedUrlKey * @memberOf! () * @@ -14746,7 +14852,7 @@ export namespace compute_v1 { /** * compute.backendServices.get - * @desc Returns the specified BackendService resource. Gets a list of available backend services. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified BackendService resource. Gets a list of available backend services. * @example * * // BEFORE RUNNING: * // --------------- @@ -14874,7 +14980,7 @@ export namespace compute_v1 { /** * compute.backendServices.getHealth - * @desc Gets the most recent health check results for this BackendService. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the most recent health check results for this BackendService. * @example * * // BEFORE RUNNING: * // --------------- @@ -15013,7 +15119,7 @@ export namespace compute_v1 { /** * compute.backendServices.insert - * @desc Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information. * @example * * // BEFORE RUNNING: * // --------------- @@ -15142,7 +15248,7 @@ export namespace compute_v1 { /** * compute.backendServices.list - * @desc Retrieves the list of BackendService resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of BackendService resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -15282,7 +15388,7 @@ export namespace compute_v1 { /** * compute.backendServices.patch - * @desc Patches the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Patches the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- @@ -15417,7 +15523,7 @@ export namespace compute_v1 { /** * compute.backendServices.setSecurityPolicy - * @desc Sets the security policy for the specified backend service. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the security policy for the specified backend service. * @alias compute.backendServices.setSecurityPolicy * @memberOf! () * @@ -15494,7 +15600,7 @@ export namespace compute_v1 { /** * compute.backendServices.update - * @desc Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. * @example * * // BEFORE RUNNING: * // --------------- @@ -15895,7 +16001,7 @@ export namespace compute_v1 { /** * compute.disks.addResourcePolicies - * @desc Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation. (== suppress_warning http-rest-shadowed ==) + * @desc Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation. * @alias compute.disks.addResourcePolicies * @memberOf! () * @@ -15973,7 +16079,7 @@ export namespace compute_v1 { /** * compute.disks.aggregatedList - * @desc Retrieves an aggregated list of persistent disks. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of persistent disks. * @example * * // BEFORE RUNNING: * // --------------- @@ -16115,7 +16221,7 @@ export namespace compute_v1 { /** * compute.disks.createSnapshot - * @desc Creates a snapshot of a specified persistent disk. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a snapshot of a specified persistent disk. * @example * * // BEFORE RUNNING: * // --------------- @@ -16254,7 +16360,7 @@ export namespace compute_v1 { /** * compute.disks.delete - * @desc Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. * @example * * // BEFORE RUNNING: * // --------------- @@ -16386,7 +16492,7 @@ export namespace compute_v1 { /** * compute.disks.get - * @desc Returns a specified persistent disk. Gets a list of available persistent disks by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns a specified persistent disk. Gets a list of available persistent disks by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -16515,7 +16621,7 @@ export namespace compute_v1 { /** * compute.disks.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.disks.getIamPolicy * @memberOf! () * @@ -16589,7 +16695,7 @@ export namespace compute_v1 { /** * compute.disks.insert - * @desc Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property. * @example * * // BEFORE RUNNING: * // --------------- @@ -16722,7 +16828,7 @@ export namespace compute_v1 { /** * compute.disks.list - * @desc Retrieves a list of persistent disks contained within the specified zone. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of persistent disks contained within the specified zone. * @example * * // BEFORE RUNNING: * // --------------- @@ -16863,7 +16969,7 @@ export namespace compute_v1 { /** * compute.disks.removeResourcePolicies - * @desc Removes resource policies from a disk. (== suppress_warning http-rest-shadowed ==) + * @desc Removes resource policies from a disk. * @alias compute.disks.removeResourcePolicies * @memberOf! () * @@ -16943,7 +17049,7 @@ export namespace compute_v1 { /** * compute.disks.resize - * @desc Resizes the specified persistent disk. You can only increase the size of the disk. (== suppress_warning http-rest-shadowed ==) + * @desc Resizes the specified persistent disk. You can only increase the size of the disk. * @example * * // BEFORE RUNNING: * // --------------- @@ -17080,7 +17186,7 @@ export namespace compute_v1 { /** * compute.disks.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.disks.setIamPolicy * @memberOf! () * @@ -17155,7 +17261,7 @@ export namespace compute_v1 { /** * compute.disks.setLabels - * @desc Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation. * @example * * // BEFORE RUNNING: * // --------------- @@ -17292,7 +17398,7 @@ export namespace compute_v1 { /** * compute.disks.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.disks.testIamPermissions * @memberOf! () * @@ -17727,7 +17833,7 @@ export namespace compute_v1 { /** * compute.diskTypes.aggregatedList - * @desc Retrieves an aggregated list of disk types. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of disk types. * @example * * // BEFORE RUNNING: * // --------------- @@ -17871,7 +17977,7 @@ export namespace compute_v1 { /** * compute.diskTypes.get - * @desc Returns the specified disk type. Gets a list of available disk types by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified disk type. Gets a list of available disk types by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -18000,7 +18106,7 @@ export namespace compute_v1 { /** * compute.diskTypes.list - * @desc Retrieves a list of disk types available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of disk types available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -18229,7 +18335,7 @@ export namespace compute_v1 { /** * compute.externalVpnGateways.delete - * @desc Deletes the specified externalVpnGateway. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified externalVpnGateway. * @alias compute.externalVpnGateways.delete * @memberOf! () * @@ -18305,7 +18411,7 @@ export namespace compute_v1 { /** * compute.externalVpnGateways.get - * @desc Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request. * @alias compute.externalVpnGateways.get * @memberOf! () * @@ -18380,7 +18486,7 @@ export namespace compute_v1 { /** * compute.externalVpnGateways.insert - * @desc Creates a ExternalVpnGateway in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a ExternalVpnGateway in the specified project using the data included in the request. * @alias compute.externalVpnGateways.insert * @memberOf! () * @@ -18456,7 +18562,7 @@ export namespace compute_v1 { /** * compute.externalVpnGateways.list - * @desc Retrieves the list of ExternalVpnGateway available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of ExternalVpnGateway available to the specified project. * @alias compute.externalVpnGateways.list * @memberOf! () * @@ -18536,7 +18642,7 @@ export namespace compute_v1 { /** * compute.externalVpnGateways.setLabels - * @desc Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation. * @alias compute.externalVpnGateways.setLabels * @memberOf! () * @@ -18612,7 +18718,7 @@ export namespace compute_v1 { /** * compute.externalVpnGateways.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.externalVpnGateways.testIamPermissions * @memberOf! () * @@ -18827,7 +18933,7 @@ export namespace compute_v1 { /** * compute.firewalls.delete - * @desc Deletes the specified firewall. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified firewall. * @example * * // BEFORE RUNNING: * // --------------- @@ -18955,7 +19061,7 @@ export namespace compute_v1 { /** * compute.firewalls.get - * @desc Returns the specified firewall. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified firewall. * @example * * // BEFORE RUNNING: * // --------------- @@ -19080,7 +19186,7 @@ export namespace compute_v1 { /** * compute.firewalls.insert - * @desc Creates a firewall rule in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a firewall rule in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -19208,7 +19314,7 @@ export namespace compute_v1 { /** * compute.firewalls.list - * @desc Retrieves the list of firewall rules available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of firewall rules available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -19347,7 +19453,7 @@ export namespace compute_v1 { /** * compute.firewalls.patch - * @desc Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- @@ -19481,7 +19587,7 @@ export namespace compute_v1 { /** * compute.firewalls.update - * @desc Updates the specified firewall rule with the data included in the request. Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified firewall rule with the data included in the request. Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead. * @example * * // BEFORE RUNNING: * // --------------- @@ -19752,7 +19858,7 @@ export namespace compute_v1 { /** * compute.forwardingRules.aggregatedList - * @desc Retrieves an aggregated list of forwarding rules. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of forwarding rules. * @example * * // BEFORE RUNNING: * // --------------- @@ -19902,7 +20008,7 @@ export namespace compute_v1 { /** * compute.forwardingRules.delete - * @desc Deletes the specified ForwardingRule resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified ForwardingRule resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -20035,7 +20141,7 @@ export namespace compute_v1 { /** * compute.forwardingRules.get - * @desc Returns the specified ForwardingRule resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified ForwardingRule resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -20167,7 +20273,7 @@ export namespace compute_v1 { /** * compute.forwardingRules.insert - * @desc Creates a ForwardingRule resource in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a ForwardingRule resource in the specified project and region using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -20301,7 +20407,7 @@ export namespace compute_v1 { /** * compute.forwardingRules.list - * @desc Retrieves a list of ForwardingRule resources available to the specified project and region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of ForwardingRule resources available to the specified project and region. * @example * * // BEFORE RUNNING: * // --------------- @@ -20446,7 +20552,7 @@ export namespace compute_v1 { /** * compute.forwardingRules.setTarget - * @desc Changes target URL for forwarding rule. The new target should be of the same type as the old target. (== suppress_warning http-rest-shadowed ==) + * @desc Changes target URL for forwarding rule. The new target should be of the same type as the old target. * @example * * // BEFORE RUNNING: * // --------------- @@ -20750,7 +20856,7 @@ export namespace compute_v1 { /** * compute.globalAddresses.delete - * @desc Deletes the specified address resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified address resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -20879,7 +20985,7 @@ export namespace compute_v1 { /** * compute.globalAddresses.get - * @desc Returns the specified address resource. Gets a list of available addresses by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified address resource. Gets a list of available addresses by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -21005,7 +21111,7 @@ export namespace compute_v1 { /** * compute.globalAddresses.insert - * @desc Creates an address resource in the specified project by using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates an address resource in the specified project by using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -21134,7 +21240,7 @@ export namespace compute_v1 { /** * compute.globalAddresses.list - * @desc Retrieves a list of global addresses. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of global addresses. * @example * * // BEFORE RUNNING: * // --------------- @@ -21367,7 +21473,7 @@ export namespace compute_v1 { /** * compute.globalForwardingRules.delete - * @desc Deletes the specified GlobalForwardingRule resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified GlobalForwardingRule resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -21496,7 +21602,7 @@ export namespace compute_v1 { /** * compute.globalForwardingRules.get - * @desc Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -21624,7 +21730,7 @@ export namespace compute_v1 { /** * compute.globalForwardingRules.insert - * @desc Creates a GlobalForwardingRule resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a GlobalForwardingRule resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -21753,7 +21859,7 @@ export namespace compute_v1 { /** * compute.globalForwardingRules.list - * @desc Retrieves a list of GlobalForwardingRule resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of GlobalForwardingRule resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -21893,7 +21999,7 @@ export namespace compute_v1 { /** * compute.globalForwardingRules.setTarget - * @desc Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target. (== suppress_warning http-rest-shadowed ==) + * @desc Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target. * @example * * // BEFORE RUNNING: * // --------------- @@ -22145,7 +22251,7 @@ export namespace compute_v1 { /** * compute.globalOperations.aggregatedList - * @desc Retrieves an aggregated list of all operations. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of all operations. * @example * * // BEFORE RUNNING: * // --------------- @@ -22289,7 +22395,7 @@ export namespace compute_v1 { /** * compute.globalOperations.delete - * @desc Deletes the specified Operations resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified Operations resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -22412,7 +22518,7 @@ export namespace compute_v1 { /** * compute.globalOperations.get - * @desc Retrieves the specified Operations resource. Gets a list of operations by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the specified Operations resource. Gets a list of operations by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -22540,7 +22646,7 @@ export namespace compute_v1 { /** * compute.globalOperations.list - * @desc Retrieves a list of Operation resources contained within the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of Operation resources contained within the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -22677,6 +22783,81 @@ export namespace compute_v1 { return createAPIRequest(parameters); } } + + /** + * compute.globalOperations.wait + * @desc Waits for the specified Operations resource until it is done or timeout, and retrieves the specified Operations resource. 1. Immediately returns when the operation is already done. 2. Waits for no more than the default deadline (2 minutes, subject to change) and then returns the current state of the operation, which may be DONE or still in progress. 3. Is best-effort: a. The server can wait less than the default deadline or zero seconds, in overload situations. b. There is no guarantee that the operation is actually done when returns. 4. User should be prepared to retry if the operation is not DONE. + * @alias compute.globalOperations.wait + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.operation Name of the Operations resource to return. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + wait( + params?: Params$Resource$Globaloperations$Wait, + options?: MethodOptions + ): GaxiosPromise; + wait( + params: Params$Resource$Globaloperations$Wait, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Globaloperations$Wait, + callback: BodyResponseCallback + ): void; + wait(callback: BodyResponseCallback): void; + wait( + paramsOrCallback?: + | Params$Resource$Globaloperations$Wait + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globaloperations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globaloperations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/global/operations/{operation}/wait' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'operation'], + pathParams: ['operation', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Globaloperations$Aggregatedlist @@ -22767,6 +22948,22 @@ export namespace compute_v1 { */ project?: string; } + export interface Params$Resource$Globaloperations$Wait + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the Operations resource to return. + */ + operation?: string; + /** + * Project ID for this request. + */ + project?: string; + } export class Resource$Healthchecks { context: APIRequestContext; @@ -22776,7 +22973,7 @@ export namespace compute_v1 { /** * compute.healthChecks.aggregatedList - * @desc Retrieves the list of all HealthCheck resources, regional and global, available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of all HealthCheck resources, regional and global, available to the specified project. * @alias compute.healthChecks.aggregatedList * @memberOf! () * @@ -22860,7 +23057,7 @@ export namespace compute_v1 { /** * compute.healthChecks.delete - * @desc Deletes the specified HealthCheck resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified HealthCheck resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -22989,7 +23186,7 @@ export namespace compute_v1 { /** * compute.healthChecks.get - * @desc Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -23116,7 +23313,7 @@ export namespace compute_v1 { /** * compute.healthChecks.insert - * @desc Creates a HealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a HealthCheck resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -23245,7 +23442,7 @@ export namespace compute_v1 { /** * compute.healthChecks.list - * @desc Retrieves the list of HealthCheck resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of HealthCheck resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -23385,7 +23582,7 @@ export namespace compute_v1 { /** * compute.healthChecks.patch - * @desc Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- @@ -23520,7 +23717,7 @@ export namespace compute_v1 { /** * compute.healthChecks.update - * @desc Updates a HealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -23825,7 +24022,7 @@ export namespace compute_v1 { /** * compute.httpHealthChecks.delete - * @desc Deletes the specified HttpHealthCheck resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified HttpHealthCheck resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -23954,7 +24151,7 @@ export namespace compute_v1 { /** * compute.httpHealthChecks.get - * @desc Returns the specified HttpHealthCheck resource. Gets a list of available HTTP health checks by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified HttpHealthCheck resource. Gets a list of available HTTP health checks by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -24082,7 +24279,7 @@ export namespace compute_v1 { /** * compute.httpHealthChecks.insert - * @desc Creates a HttpHealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a HttpHealthCheck resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -24211,7 +24408,7 @@ export namespace compute_v1 { /** * compute.httpHealthChecks.list - * @desc Retrieves the list of HttpHealthCheck resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of HttpHealthCheck resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -24351,7 +24548,7 @@ export namespace compute_v1 { /** * compute.httpHealthChecks.patch - * @desc Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- @@ -24486,7 +24683,7 @@ export namespace compute_v1 { /** * compute.httpHealthChecks.update - * @desc Updates a HttpHealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Updates a HttpHealthCheck resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -24764,7 +24961,7 @@ export namespace compute_v1 { /** * compute.httpsHealthChecks.delete - * @desc Deletes the specified HttpsHealthCheck resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified HttpsHealthCheck resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -24893,7 +25090,7 @@ export namespace compute_v1 { /** * compute.httpsHealthChecks.get - * @desc Returns the specified HttpsHealthCheck resource. Gets a list of available HTTPS health checks by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified HttpsHealthCheck resource. Gets a list of available HTTPS health checks by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -25021,7 +25218,7 @@ export namespace compute_v1 { /** * compute.httpsHealthChecks.insert - * @desc Creates a HttpsHealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a HttpsHealthCheck resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -25151,7 +25348,7 @@ export namespace compute_v1 { /** * compute.httpsHealthChecks.list - * @desc Retrieves the list of HttpsHealthCheck resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of HttpsHealthCheck resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -25294,7 +25491,7 @@ export namespace compute_v1 { /** * compute.httpsHealthChecks.patch - * @desc Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- @@ -25429,7 +25626,7 @@ export namespace compute_v1 { /** * compute.httpsHealthChecks.update - * @desc Updates a HttpsHealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Updates a HttpsHealthCheck resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -25707,7 +25904,7 @@ export namespace compute_v1 { /** * compute.images.delete - * @desc Deletes the specified image. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified image. * @example * * // BEFORE RUNNING: * // --------------- @@ -25834,7 +26031,7 @@ export namespace compute_v1 { /** * compute.images.deprecate - * @desc Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead. * @example * * // BEFORE RUNNING: * // --------------- @@ -25967,7 +26164,7 @@ export namespace compute_v1 { /** * compute.images.get - * @desc Returns the specified image. Gets a list of available images by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified image. Gets a list of available images by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -26091,7 +26288,7 @@ export namespace compute_v1 { /** * compute.images.getFromFamily - * @desc Returns the latest image that is part of an image family and is not deprecated. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the latest image that is part of an image family and is not deprecated. * @example * * // BEFORE RUNNING: * // --------------- @@ -26217,7 +26414,7 @@ export namespace compute_v1 { /** * compute.images.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.images.getIamPolicy * @memberOf! () * @@ -26290,7 +26487,7 @@ export namespace compute_v1 { /** * compute.images.insert - * @desc Creates an image in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates an image in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -26419,7 +26616,7 @@ export namespace compute_v1 { /** * compute.images.list - * @desc Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. * @example * * // BEFORE RUNNING: * // --------------- @@ -26558,7 +26755,7 @@ export namespace compute_v1 { /** * compute.images.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.images.setIamPolicy * @memberOf! () * @@ -26632,7 +26829,7 @@ export namespace compute_v1 { /** * compute.images.setLabels - * @desc Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation. * @example * * // BEFORE RUNNING: * // --------------- @@ -26764,7 +26961,7 @@ export namespace compute_v1 { /** * compute.images.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.images.testIamPermissions * @memberOf! () * @@ -27055,7 +27252,7 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.abandonInstances - * @desc Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. (== suppress_warning http-rest-shadowed ==) + * @desc Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @example * * // BEFORE RUNNING: * // --------------- @@ -27193,7 +27390,7 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.aggregatedList - * @desc Retrieves the list of managed instance groups and groups them by zone. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of managed instance groups and groups them by zone. * @example * * // BEFORE RUNNING: * // --------------- @@ -27342,93 +27539,38 @@ export namespace compute_v1 { } /** - * compute.instanceGroupManagers.delete - * @desc Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information. (== suppress_warning http-rest-shadowed ==) - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Compute Engine API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more information, see - * // https://developers.google.com/identity/protocols/application-default-credentials - * // 3. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var compute = google.compute('v1'); - * - * authorize(function(authClient) { - * var request = { - * // Project ID for this request. - * project: 'my-project', // TODO: Update placeholder value. - * - * // The name of the zone where the managed instance group is located. - * zone: 'my-zone', // TODO: Update placeholder value. - * - * // The name of the managed instance group to delete. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * compute.instanceGroupManagers.delete(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); - * }); - * } - * @alias compute.instanceGroupManagers.delete + * compute.instanceGroupManagers.createInstances + * @desc Creates instances with per-instance configs in this managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method. + * @alias compute.instanceGroupManagers.createInstances * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.instanceGroupManager The name of the managed instance group to delete. + * @param {string} params.instanceGroupManager The name of the managed instance group. It should conform to RFC1035. * @param {string} params.project Project ID for this request. - * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - * @param {string} params.zone The name of the zone where the managed instance group is located. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone where the managed instance group is located. It should conform to RFC1035. + * @param {().InstanceGroupManagersCreateInstancesRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - delete( - params?: Params$Resource$Instancegroupmanagers$Delete, + createInstances( + params?: Params$Resource$Instancegroupmanagers$Createinstances, options?: MethodOptions ): GaxiosPromise; - delete( - params: Params$Resource$Instancegroupmanagers$Delete, + createInstances( + params: Params$Resource$Instancegroupmanagers$Createinstances, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Instancegroupmanagers$Delete, + createInstances( + params: Params$Resource$Instancegroupmanagers$Createinstances, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + createInstances(callback: BodyResponseCallback): void; + createInstances( paramsOrCallback?: - | Params$Resource$Instancegroupmanagers$Delete + | Params$Resource$Instancegroupmanagers$Createinstances | BodyResponseCallback, optionsOrCallback?: | MethodOptions @@ -27436,12 +27578,12 @@ export namespace compute_v1 { callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagers$Delete; + {}) as Params$Resource$Instancegroupmanagers$Createinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroupmanagers$Delete; + params = {} as Params$Resource$Instancegroupmanagers$Createinstances; options = {}; } @@ -27456,9 +27598,9 @@ export namespace compute_v1 { { url: ( rootUrl + - '/compute/v1/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}' + '/compute/v1/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/createInstances' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'POST', }, options ), @@ -27475,8 +27617,8 @@ export namespace compute_v1 { } /** - * compute.instanceGroupManagers.deleteInstances - * @desc Flags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. (== suppress_warning http-rest-shadowed ==) + * compute.instanceGroupManagers.delete + * @desc Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information. * @example * * // BEFORE RUNNING: * // --------------- @@ -27503,17 +27645,13 @@ export namespace compute_v1 { * // The name of the zone where the managed instance group is located. * zone: 'my-zone', // TODO: Update placeholder value. * - * // The name of the managed instance group. + * // The name of the managed instance group to delete. * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * * auth: authClient, * }; * - * compute.instanceGroupManagers.deleteInstances(request, function(err, response) { + * compute.instanceGroupManagers.delete(request, function(err, response) { * if (err) { * console.error(err); * return; @@ -27537,36 +27675,35 @@ export namespace compute_v1 { * callback(authClient); * }); * } - * @alias compute.instanceGroupManagers.deleteInstances + * @alias compute.instanceGroupManagers.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.instanceGroupManager The name of the managed instance group. + * @param {string} params.instanceGroupManager The name of the managed instance group to delete. * @param {string} params.project Project ID for this request. * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). * @param {string} params.zone The name of the zone where the managed instance group is located. - * @param {().InstanceGroupManagersDeleteInstancesRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - deleteInstances( - params?: Params$Resource$Instancegroupmanagers$Deleteinstances, + delete( + params?: Params$Resource$Instancegroupmanagers$Delete, options?: MethodOptions ): GaxiosPromise; - deleteInstances( - params: Params$Resource$Instancegroupmanagers$Deleteinstances, + delete( + params: Params$Resource$Instancegroupmanagers$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deleteInstances( - params: Params$Resource$Instancegroupmanagers$Deleteinstances, + delete( + params: Params$Resource$Instancegroupmanagers$Delete, callback: BodyResponseCallback ): void; - deleteInstances(callback: BodyResponseCallback): void; - deleteInstances( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Instancegroupmanagers$Deleteinstances + | Params$Resource$Instancegroupmanagers$Delete | BodyResponseCallback, optionsOrCallback?: | MethodOptions @@ -27574,12 +27711,12 @@ export namespace compute_v1 { callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagers$Deleteinstances; + {}) as Params$Resource$Instancegroupmanagers$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroupmanagers$Deleteinstances; + params = {} as Params$Resource$Instancegroupmanagers$Delete; options = {}; } @@ -27594,9 +27731,9 @@ export namespace compute_v1 { { url: ( rootUrl + - '/compute/v1/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances' + '/compute/v1/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'DELETE', }, options ), @@ -27613,8 +27750,146 @@ export namespace compute_v1 { } /** - * compute.instanceGroupManagers.get - * @desc Returns all of the details about the specified managed instance group. Gets a list of available managed instance groups by making a list() request. (== suppress_warning http-rest-shadowed ==) + * compute.instanceGroupManagers.deleteInstances + * @desc Flags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Compute Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/compute + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * var google = require('googleapis'); + * var compute = google.compute('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Project ID for this request. + * project: 'my-project', // TODO: Update placeholder value. + * + * // The name of the zone where the managed instance group is located. + * zone: 'my-zone', // TODO: Update placeholder value. + * + * // The name of the managed instance group. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * compute.instanceGroupManagers.deleteInstances(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getApplicationDefault(function(err, authClient) { + * if (err) { + * console.error('authentication failed: ', err); + * return; + * } + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); + * } + * callback(authClient); + * }); + * } + * @alias compute.instanceGroupManagers.deleteInstances + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroupManager The name of the managed instance group. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone where the managed instance group is located. + * @param {().InstanceGroupManagersDeleteInstancesRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + deleteInstances( + params?: Params$Resource$Instancegroupmanagers$Deleteinstances, + options?: MethodOptions + ): GaxiosPromise; + deleteInstances( + params: Params$Resource$Instancegroupmanagers$Deleteinstances, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deleteInstances( + params: Params$Resource$Instancegroupmanagers$Deleteinstances, + callback: BodyResponseCallback + ): void; + deleteInstances(callback: BodyResponseCallback): void; + deleteInstances( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagers$Deleteinstances + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagers$Deleteinstances; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroupmanagers$Deleteinstances; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instanceGroupManagers.get + * @desc Returns all of the details about the specified managed instance group. Gets a list of available managed instance groups by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -27748,7 +28023,7 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.insert - * @desc Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit. * @example * * // BEFORE RUNNING: * // --------------- @@ -27882,7 +28157,7 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.list - * @desc Retrieves a list of managed instance groups that are contained within the specified project and zone. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of managed instance groups that are contained within the specified project and zone. * @example * * // BEFORE RUNNING: * // --------------- @@ -28029,7 +28304,7 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.listManagedInstances - * @desc Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. (== suppress_warning http-rest-shadowed ==) + * @desc Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. * @example * * // BEFORE RUNNING: * // --------------- @@ -28189,7 +28464,7 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.patch - * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.instanceGroupManagers.patch * @memberOf! () * @@ -28267,7 +28542,7 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.recreateInstances - * @desc Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. (== suppress_warning http-rest-shadowed ==) + * @desc Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @example * * // BEFORE RUNNING: * // --------------- @@ -28405,7 +28680,7 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.resize - * @desc Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including: + The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. (== suppress_warning http-rest-shadowed ==) + * @desc Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including: + The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. * @example * * // BEFORE RUNNING: * // --------------- @@ -28544,7 +28819,7 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.setInstanceTemplate - * @desc Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them. (== suppress_warning http-rest-shadowed ==) + * @desc Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them. * @example * * // BEFORE RUNNING: * // --------------- @@ -28682,7 +28957,7 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.setTargetPools - * @desc Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group. (== suppress_warning http-rest-shadowed ==) + * @desc Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group. * @example * * // BEFORE RUNNING: * // --------------- @@ -28876,6 +29151,35 @@ export namespace compute_v1 { */ project?: string; } + export interface Params$Resource$Instancegroupmanagers$Createinstances + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the managed instance group. It should conform to RFC1035. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone where the managed instance group is located. It should conform to RFC1035. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManagersCreateInstancesRequest; + } export interface Params$Resource$Instancegroupmanagers$Delete extends StandardParameters { /** @@ -29195,7 +29499,7 @@ export namespace compute_v1 { /** * compute.instanceGroups.addInstances - * @desc Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information. (== suppress_warning http-rest-shadowed ==) + * @desc Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information. * @example * * // BEFORE RUNNING: * // --------------- @@ -29333,7 +29637,7 @@ export namespace compute_v1 { /** * compute.instanceGroups.aggregatedList - * @desc Retrieves the list of instance groups and sorts them by zone. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of instance groups and sorts them by zone. * @example * * // BEFORE RUNNING: * // --------------- @@ -29481,7 +29785,7 @@ export namespace compute_v1 { /** * compute.instanceGroups.delete - * @desc Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information. * @example * * // BEFORE RUNNING: * // --------------- @@ -29614,7 +29918,7 @@ export namespace compute_v1 { /** * compute.instanceGroups.get - * @desc Returns the specified instance group. Gets a list of available instance groups by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified instance group. Gets a list of available instance groups by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -29746,7 +30050,7 @@ export namespace compute_v1 { /** * compute.instanceGroups.insert - * @desc Creates an instance group in the specified project using the parameters that are included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates an instance group in the specified project using the parameters that are included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -29880,7 +30184,7 @@ export namespace compute_v1 { /** * compute.instanceGroups.list - * @desc Retrieves the list of instance groups that are located in the specified project and zone. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of instance groups that are located in the specified project and zone. * @example * * // BEFORE RUNNING: * // --------------- @@ -30025,7 +30329,7 @@ export namespace compute_v1 { /** * compute.instanceGroups.listInstances - * @desc Lists the instances in the specified instance group. (== suppress_warning http-rest-shadowed ==) + * @desc Lists the instances in the specified instance group. * @example * * // BEFORE RUNNING: * // --------------- @@ -30186,7 +30490,7 @@ export namespace compute_v1 { /** * compute.instanceGroups.removeInstances - * @desc Removes one or more instances from the specified instance group, but does not delete those instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted. (== suppress_warning http-rest-shadowed ==) + * @desc Removes one or more instances from the specified instance group, but does not delete those instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted. * @example * * // BEFORE RUNNING: * // --------------- @@ -30324,7 +30628,7 @@ export namespace compute_v1 { /** * compute.instanceGroups.setNamedPorts - * @desc Sets the named ports for the specified instance group. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the named ports for the specified instance group. * @example * * // BEFORE RUNNING: * // --------------- @@ -30727,7 +31031,7 @@ export namespace compute_v1 { /** * compute.instances.addAccessConfig - * @desc Adds an access config to an instance's network interface. (== suppress_warning http-rest-shadowed ==) + * @desc Adds an access config to an instance's network interface. * @example * * // BEFORE RUNNING: * // --------------- @@ -30869,7 +31173,7 @@ export namespace compute_v1 { /** * compute.instances.aggregatedList - * @desc Retrieves aggregated list of all of the instances in your project across all regions and zones. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves aggregated list of all of the instances in your project across all regions and zones. * @example * * // BEFORE RUNNING: * // --------------- @@ -31013,7 +31317,7 @@ export namespace compute_v1 { /** * compute.instances.attachDisk - * @desc Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance. (== suppress_warning http-rest-shadowed ==) + * @desc Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance. * @example * * // BEFORE RUNNING: * // --------------- @@ -31152,7 +31456,7 @@ export namespace compute_v1 { /** * compute.instances.delete - * @desc Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance. * @example * * // BEFORE RUNNING: * // --------------- @@ -31284,7 +31588,7 @@ export namespace compute_v1 { /** * compute.instances.deleteAccessConfig - * @desc Deletes an access config from an instance's network interface. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes an access config from an instance's network interface. * @example * * // BEFORE RUNNING: * // --------------- @@ -31431,7 +31735,7 @@ export namespace compute_v1 { /** * compute.instances.detachDisk - * @desc Detaches a disk from an instance. (== suppress_warning http-rest-shadowed ==) + * @desc Detaches a disk from an instance. * @example * * // BEFORE RUNNING: * // --------------- @@ -31568,7 +31872,7 @@ export namespace compute_v1 { /** * compute.instances.get - * @desc Returns the specified Instance resource. Gets a list of available instances by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified Instance resource. Gets a list of available instances by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -31697,7 +32001,7 @@ export namespace compute_v1 { /** * compute.instances.getGuestAttributes - * @desc Returns the specified guest attributes entry. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified guest attributes entry. * @alias compute.instances.getGuestAttributes * @memberOf! () * @@ -31777,7 +32081,7 @@ export namespace compute_v1 { /** * compute.instances.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.instances.getIamPolicy * @memberOf! () * @@ -31851,7 +32155,7 @@ export namespace compute_v1 { /** * compute.instances.getSerialPortOutput - * @desc Returns the last 1 MB of serial port output from the specified instance. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the last 1 MB of serial port output from the specified instance. * @example * * // BEFORE RUNNING: * // --------------- @@ -31987,7 +32291,7 @@ export namespace compute_v1 { /** * compute.instances.getShieldedInstanceIdentity - * @desc Returns the Shielded Instance Identity of an instance (== suppress_warning http-rest-shadowed ==) + * @desc Returns the Shielded Instance Identity of an instance * @alias compute.instances.getShieldedInstanceIdentity * @memberOf! () * @@ -32067,7 +32371,7 @@ export namespace compute_v1 { /** * compute.instances.insert - * @desc Creates an instance resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates an instance resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -32200,7 +32504,7 @@ export namespace compute_v1 { /** * compute.instances.list - * @desc Retrieves the list of instances contained within the specified zone. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of instances contained within the specified zone. * @example * * // BEFORE RUNNING: * // --------------- @@ -32343,7 +32647,7 @@ export namespace compute_v1 { /** * compute.instances.listReferrers - * @desc Retrieves the list of referrers to instances contained within the specified zone. For more information, read Viewing Referrers to VM Instances. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of referrers to instances contained within the specified zone. For more information, read Viewing Referrers to VM Instances. * @alias compute.instances.listReferrers * @memberOf! () * @@ -32427,7 +32731,7 @@ export namespace compute_v1 { /** * compute.instances.reset - * @desc Performs a reset on the instance. This is a hard reset the VM does not do a graceful shutdown. For more information, see Resetting an instance. (== suppress_warning http-rest-shadowed ==) + * @desc Performs a reset on the instance. This is a hard reset the VM does not do a graceful shutdown. For more information, see Resetting an instance. * @example * * // BEFORE RUNNING: * // --------------- @@ -32559,7 +32863,7 @@ export namespace compute_v1 { /** * compute.instances.setDeletionProtection - * @desc Sets deletion protection on the instance. (== suppress_warning http-rest-shadowed ==) + * @desc Sets deletion protection on the instance. * @example * * // BEFORE RUNNING: * // --------------- @@ -32695,7 +32999,7 @@ export namespace compute_v1 { /** * compute.instances.setDiskAutoDelete - * @desc Sets the auto-delete flag for a disk attached to an instance. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the auto-delete flag for a disk attached to an instance. * @example * * // BEFORE RUNNING: * // --------------- @@ -32842,7 +33146,7 @@ export namespace compute_v1 { /** * compute.instances.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.instances.setIamPolicy * @memberOf! () * @@ -32917,7 +33221,7 @@ export namespace compute_v1 { /** * compute.instances.setLabels - * @desc Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) + * @desc Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation. * @example * * // BEFORE RUNNING: * // --------------- @@ -33055,7 +33359,7 @@ export namespace compute_v1 { /** * compute.instances.setMachineResources - * @desc Changes the number and/or type of accelerator for a stopped instance to the values specified in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Changes the number and/or type of accelerator for a stopped instance to the values specified in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -33193,7 +33497,7 @@ export namespace compute_v1 { /** * compute.instances.setMachineType - * @desc Changes the machine type for a stopped instance to the machine type specified in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Changes the machine type for a stopped instance to the machine type specified in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -33331,7 +33635,7 @@ export namespace compute_v1 { /** * compute.instances.setMetadata - * @desc Sets metadata for the specified instance to the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Sets metadata for the specified instance to the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -33469,7 +33773,7 @@ export namespace compute_v1 { /** * compute.instances.setMinCpuPlatform - * @desc Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform. (== suppress_warning http-rest-shadowed ==) + * @desc Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform. * @example * * // BEFORE RUNNING: * // --------------- @@ -33607,7 +33911,7 @@ export namespace compute_v1 { /** * compute.instances.setScheduling - * @desc Sets an instance's scheduling options. (== suppress_warning http-rest-shadowed ==) + * @desc Sets an instance's scheduling options. * @example * * // BEFORE RUNNING: * // --------------- @@ -33745,7 +34049,7 @@ export namespace compute_v1 { /** * compute.instances.setServiceAccount - * @desc Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance. * @example * * // BEFORE RUNNING: * // --------------- @@ -33883,7 +34187,7 @@ export namespace compute_v1 { /** * compute.instances.setShieldedInstanceIntegrityPolicy - * @desc Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.instances.setShieldedInstanceIntegrityPolicy * @memberOf! () * @@ -33963,7 +34267,7 @@ export namespace compute_v1 { /** * compute.instances.setTags - * @desc Sets network tags for the specified instance to the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Sets network tags for the specified instance to the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -34101,7 +34405,7 @@ export namespace compute_v1 { /** * compute.instances.simulateMaintenanceEvent - * @desc Simulates a maintenance event on the instance. (== suppress_warning http-rest-shadowed ==) + * @desc Simulates a maintenance event on the instance. * @alias compute.instances.simulateMaintenanceEvent * @memberOf! () * @@ -34179,7 +34483,7 @@ export namespace compute_v1 { /** * compute.instances.start - * @desc Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. (== suppress_warning http-rest-shadowed ==) + * @desc Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. * @example * * // BEFORE RUNNING: * // --------------- @@ -34311,7 +34615,7 @@ export namespace compute_v1 { /** * compute.instances.startWithEncryptionKey - * @desc Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. (== suppress_warning http-rest-shadowed ==) + * @desc Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. * @example * * // BEFORE RUNNING: * // --------------- @@ -34451,7 +34755,7 @@ export namespace compute_v1 { /** * compute.instances.stop - * @desc Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance. (== suppress_warning http-rest-shadowed ==) + * @desc Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance. * @example * * // BEFORE RUNNING: * // --------------- @@ -34583,7 +34887,7 @@ export namespace compute_v1 { /** * compute.instances.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.instances.testIamPermissions * @memberOf! () * @@ -34664,7 +34968,7 @@ export namespace compute_v1 { /** * compute.instances.updateAccessConfig - * @desc Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.instances.updateAccessConfig * @memberOf! () * @@ -34743,7 +35047,7 @@ export namespace compute_v1 { /** * compute.instances.updateDisplayDevice - * @desc Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.instances.updateDisplayDevice * @memberOf! () * @@ -34821,7 +35125,7 @@ export namespace compute_v1 { /** * compute.instances.updateNetworkInterface - * @desc Updates an instance's network interface. This method follows PATCH semantics. (== suppress_warning http-rest-shadowed ==) + * @desc Updates an instance's network interface. This method follows PATCH semantics. * @alias compute.instances.updateNetworkInterface * @memberOf! () * @@ -34902,7 +35206,7 @@ export namespace compute_v1 { /** * compute.instances.updateShieldedInstanceConfig - * @desc Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.instances.updateShieldedInstanceConfig * @memberOf! () * @@ -35990,7 +36294,7 @@ export namespace compute_v1 { /** * compute.instanceTemplates.delete - * @desc Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are already in use by a managed instance group. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are already in use by a managed instance group. * @example * * // BEFORE RUNNING: * // --------------- @@ -36119,7 +36423,7 @@ export namespace compute_v1 { /** * compute.instanceTemplates.get - * @desc Returns the specified instance template. Gets a list of available instance templates by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified instance template. Gets a list of available instance templates by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -36247,7 +36551,7 @@ export namespace compute_v1 { /** * compute.instanceTemplates.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.instanceTemplates.getIamPolicy * @memberOf! () * @@ -36320,7 +36624,7 @@ export namespace compute_v1 { /** * compute.instanceTemplates.insert - * @desc Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template. (== suppress_warning http-rest-shadowed ==) + * @desc Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template. * @example * * // BEFORE RUNNING: * // --------------- @@ -36450,7 +36754,7 @@ export namespace compute_v1 { /** * compute.instanceTemplates.list - * @desc Retrieves a list of instance templates that are contained within the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of instance templates that are contained within the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -36593,7 +36897,7 @@ export namespace compute_v1 { /** * compute.instanceTemplates.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.instanceTemplates.setIamPolicy * @memberOf! () * @@ -36667,7 +36971,7 @@ export namespace compute_v1 { /** * compute.instanceTemplates.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.instanceTemplates.testIamPermissions * @memberOf! () * @@ -36898,7 +37202,7 @@ export namespace compute_v1 { /** * compute.interconnectAttachments.aggregatedList - * @desc Retrieves an aggregated list of interconnect attachments. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of interconnect attachments. * @example * * // BEFORE RUNNING: * // --------------- @@ -37056,7 +37360,7 @@ export namespace compute_v1 { /** * compute.interconnectAttachments.delete - * @desc Deletes the specified interconnect attachment. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified interconnect attachment. * @example * * // BEFORE RUNNING: * // --------------- @@ -37189,7 +37493,7 @@ export namespace compute_v1 { /** * compute.interconnectAttachments.get - * @desc Returns the specified interconnect attachment. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified interconnect attachment. * @example * * // BEFORE RUNNING: * // --------------- @@ -37323,7 +37627,7 @@ export namespace compute_v1 { /** * compute.interconnectAttachments.insert - * @desc Creates an InterconnectAttachment in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates an InterconnectAttachment in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -37388,6 +37692,7 @@ export namespace compute_v1 { * @param {string} params.project Project ID for this request. * @param {string} params.region Name of the region for this request. * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {boolean=} params.validateOnly If true, the request will not be committed. * @param {().InterconnectAttachment} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -37457,7 +37762,7 @@ export namespace compute_v1 { /** * compute.interconnectAttachments.list - * @desc Retrieves the list of interconnect attachments contained within the specified region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of interconnect attachments contained within the specified region. * @example * * // BEFORE RUNNING: * // --------------- @@ -37609,7 +37914,7 @@ export namespace compute_v1 { /** * compute.interconnectAttachments.patch - * @desc Updates the specified interconnect attachment with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified interconnect attachment with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.interconnectAttachments.patch * @memberOf! () * @@ -37777,6 +38082,10 @@ export namespace compute_v1 { * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; + /** + * If true, the request will not be committed. + */ + validateOnly?: boolean; /** * Request body metadata @@ -37853,7 +38162,7 @@ export namespace compute_v1 { /** * compute.interconnectLocations.get - * @desc Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -37983,7 +38292,7 @@ export namespace compute_v1 { /** * compute.interconnectLocations.list - * @desc Retrieves the list of interconnect locations available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of interconnect locations available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -38178,7 +38487,7 @@ export namespace compute_v1 { /** * compute.interconnects.delete - * @desc Deletes the specified interconnect. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified interconnect. * @example * * // BEFORE RUNNING: * // --------------- @@ -38307,7 +38616,7 @@ export namespace compute_v1 { /** * compute.interconnects.get - * @desc Returns the specified interconnect. Get a list of available interconnects by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified interconnect. Get a list of available interconnects by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -38435,7 +38744,7 @@ export namespace compute_v1 { /** * compute.interconnects.getDiagnostics - * @desc Returns the interconnectDiagnostics for the specified interconnect. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the interconnectDiagnostics for the specified interconnect. * @alias compute.interconnects.getDiagnostics * @memberOf! () * @@ -38521,7 +38830,7 @@ export namespace compute_v1 { /** * compute.interconnects.insert - * @desc Creates a Interconnect in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a Interconnect in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -38650,7 +38959,7 @@ export namespace compute_v1 { /** * compute.interconnects.list - * @desc Retrieves the list of interconnect available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of interconnect available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -38790,7 +39099,7 @@ export namespace compute_v1 { /** * compute.interconnects.patch - * @desc Updates the specified interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- @@ -39059,7 +39368,7 @@ export namespace compute_v1 { /** * compute.licenseCodes.get - * @desc Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code. (== suppress_warning http-rest-shadowed ==) + * @desc Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code. * @alias compute.licenseCodes.get * @memberOf! () * @@ -39133,7 +39442,7 @@ export namespace compute_v1 { /** * compute.licenseCodes.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.licenseCodes.testIamPermissions * @memberOf! () * @@ -39257,7 +39566,7 @@ export namespace compute_v1 { /** * compute.licenses.delete - * @desc Deletes the specified license. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified license. * @alias compute.licenses.delete * @memberOf! () * @@ -39332,7 +39641,7 @@ export namespace compute_v1 { /** * compute.licenses.get - * @desc Returns the specified License resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified License resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -39457,7 +39766,7 @@ export namespace compute_v1 { /** * compute.licenses.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.licenses.getIamPolicy * @memberOf! () * @@ -39530,7 +39839,7 @@ export namespace compute_v1 { /** * compute.licenses.insert - * @desc Create a License resource in the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Create a License resource in the specified project. * @alias compute.licenses.insert * @memberOf! () * @@ -39604,7 +39913,7 @@ export namespace compute_v1 { /** * compute.licenses.list - * @desc Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. * @alias compute.licenses.list * @memberOf! () * @@ -39682,7 +39991,7 @@ export namespace compute_v1 { /** * compute.licenses.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.licenses.setIamPolicy * @memberOf! () * @@ -39756,7 +40065,7 @@ export namespace compute_v1 { /** * compute.licenses.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.licenses.testIamPermissions * @memberOf! () * @@ -39983,7 +40292,7 @@ export namespace compute_v1 { /** * compute.machineTypes.aggregatedList - * @desc Retrieves an aggregated list of machine types. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of machine types. * @example * * // BEFORE RUNNING: * // --------------- @@ -40130,7 +40439,7 @@ export namespace compute_v1 { /** * compute.machineTypes.get - * @desc Returns the specified machine type. Gets a list of available machine types by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified machine type. Gets a list of available machine types by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -40261,7 +40570,7 @@ export namespace compute_v1 { /** * compute.machineTypes.list - * @desc Retrieves a list of machine types available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of machine types available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -40493,7 +40802,7 @@ export namespace compute_v1 { /** * compute.networkEndpointGroups.aggregatedList - * @desc Retrieves the list of network endpoint groups and sorts them by zone. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of network endpoint groups and sorts them by zone. * @alias compute.networkEndpointGroups.aggregatedList * @memberOf! () * @@ -40580,7 +40889,7 @@ export namespace compute_v1 { /** * compute.networkEndpointGroups.attachNetworkEndpoints - * @desc Attach a list of network endpoints to the specified network endpoint group. (== suppress_warning http-rest-shadowed ==) + * @desc Attach a list of network endpoints to the specified network endpoint group. * @alias compute.networkEndpointGroups.attachNetworkEndpoints * @memberOf! () * @@ -40660,7 +40969,7 @@ export namespace compute_v1 { /** * compute.networkEndpointGroups.delete - * @desc Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it. (== suppress_warning http-rest-shadowed ==) + * @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! () * @@ -40737,7 +41046,7 @@ export namespace compute_v1 { /** * compute.networkEndpointGroups.detachNetworkEndpoints - * @desc Detach a list of network endpoints from the specified network endpoint group. (== suppress_warning http-rest-shadowed ==) + * @desc Detach a list of network endpoints from the specified network endpoint group. * @alias compute.networkEndpointGroups.detachNetworkEndpoints * @memberOf! () * @@ -40817,7 +41126,7 @@ export namespace compute_v1 { /** * compute.networkEndpointGroups.get - * @desc Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request. * @alias compute.networkEndpointGroups.get * @memberOf! () * @@ -40895,7 +41204,7 @@ export namespace compute_v1 { /** * compute.networkEndpointGroups.insert - * @desc Creates a network endpoint group in the specified project using the parameters that are included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a network endpoint group in the specified project using the parameters that are included in the request. * @alias compute.networkEndpointGroups.insert * @memberOf! () * @@ -40972,7 +41281,7 @@ export namespace compute_v1 { /** * compute.networkEndpointGroups.list - * @desc Retrieves the list of network endpoint groups that are located in the specified project and zone. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of network endpoint groups that are located in the specified project and zone. * @alias compute.networkEndpointGroups.list * @memberOf! () * @@ -41053,7 +41362,7 @@ export namespace compute_v1 { /** * compute.networkEndpointGroups.listNetworkEndpoints - * @desc Lists the network endpoints in the specified network endpoint group. (== suppress_warning http-rest-shadowed ==) + * @desc Lists the network endpoints in the specified network endpoint group. * @alias compute.networkEndpointGroups.listNetworkEndpoints * @memberOf! () * @@ -41157,7 +41466,7 @@ export namespace compute_v1 { /** * compute.networkEndpointGroups.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.networkEndpointGroups.testIamPermissions * @memberOf! () * @@ -41499,7 +41808,7 @@ export namespace compute_v1 { /** * compute.networks.addPeering - * @desc Adds a peering to the specified network. (== suppress_warning http-rest-shadowed ==) + * @desc Adds a peering to the specified network. * @example * * // BEFORE RUNNING: * // --------------- @@ -41633,7 +41942,7 @@ export namespace compute_v1 { /** * compute.networks.delete - * @desc Deletes the specified network. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified network. * @example * * // BEFORE RUNNING: * // --------------- @@ -41761,7 +42070,7 @@ export namespace compute_v1 { /** * compute.networks.get - * @desc Returns the specified network. Gets a list of available networks by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified network. Gets a list of available networks by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -41886,7 +42195,7 @@ export namespace compute_v1 { /** * compute.networks.insert - * @desc Creates a network in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a network in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -42014,7 +42323,7 @@ export namespace compute_v1 { /** * compute.networks.list - * @desc Retrieves the list of networks available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of networks available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -42151,9 +42460,98 @@ export namespace compute_v1 { } } + /** + * compute.networks.listPeeringRoutes + * @desc Lists the peering routes exchanged over peering connection. + * @alias compute.networks.listPeeringRoutes + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.direction The direction of the exchanged routes. + * @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.network Name of the network for this request. + * @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.peeringName The response will show routes exchanged over the given peering connection. + * @param {string} params.project Project ID for this request. + * @param {string=} params.region The region of the request. The response will include all subnet routes, static routes and dynamic routes in the region. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + listPeeringRoutes( + params?: Params$Resource$Networks$Listpeeringroutes, + options?: MethodOptions + ): GaxiosPromise; + listPeeringRoutes( + params: Params$Resource$Networks$Listpeeringroutes, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listPeeringRoutes( + params: Params$Resource$Networks$Listpeeringroutes, + callback: BodyResponseCallback + ): void; + listPeeringRoutes( + callback: BodyResponseCallback + ): void; + listPeeringRoutes( + paramsOrCallback?: + | Params$Resource$Networks$Listpeeringroutes + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Networks$Listpeeringroutes; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Networks$Listpeeringroutes; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/global/networks/{network}/listPeeringRoutes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'network'], + pathParams: ['network', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * compute.networks.patch - * @desc Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode. (== suppress_warning http-rest-shadowed ==) + * @desc Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode. * @example * * // BEFORE RUNNING: * // --------------- @@ -42287,7 +42685,7 @@ export namespace compute_v1 { /** * compute.networks.removePeering - * @desc Removes a peering from the specified network. (== suppress_warning http-rest-shadowed ==) + * @desc Removes a peering from the specified network. * @example * * // BEFORE RUNNING: * // --------------- @@ -42421,7 +42819,7 @@ export namespace compute_v1 { /** * compute.networks.switchToCustomMode - * @desc Switches the network mode from auto subnet mode to custom subnet mode. (== suppress_warning http-rest-shadowed ==) + * @desc Switches the network mode from auto subnet mode to custom subnet mode. * @example * * // BEFORE RUNNING: * // --------------- @@ -42550,7 +42948,7 @@ export namespace compute_v1 { /** * compute.networks.updatePeering - * @desc Updates the specified network peering with the data included in the request Only the following fields can be modified: NetworkPeering.export_custom_routes, and NetworkPeering.import_custom_routes (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified network peering with the data included in the request Only the following fields can be modified: NetworkPeering.export_custom_routes, and NetworkPeering.import_custom_routes * @alias compute.networks.updatePeering * @memberOf! () * @@ -42732,6 +43130,50 @@ export namespace compute_v1 { */ project?: string; } + export interface Params$Resource$Networks$Listpeeringroutes + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The direction of the exchanged routes. + */ + direction?: string; + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Name of the network for this request. + */ + network?: string; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * The response will show routes exchanged over the given peering connection. + */ + peeringName?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The region of the request. The response will include all subnet routes, static routes and dynamic routes in the region. + */ + region?: string; + } export interface Params$Resource$Networks$Patch extends StandardParameters { /** * Auth client or API Key for the request @@ -42835,7 +43277,7 @@ export namespace compute_v1 { /** * compute.nodeGroups.addNodes - * @desc Adds specified number of nodes to the node group. (== suppress_warning http-rest-shadowed ==) + * @desc Adds specified number of nodes to the node group. * @alias compute.nodeGroups.addNodes * @memberOf! () * @@ -42913,7 +43355,7 @@ export namespace compute_v1 { /** * compute.nodeGroups.aggregatedList - * @desc Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group. * @alias compute.nodeGroups.aggregatedList * @memberOf! () * @@ -42994,7 +43436,7 @@ export namespace compute_v1 { /** * compute.nodeGroups.delete - * @desc Deletes the specified NodeGroup resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified NodeGroup resource. * @alias compute.nodeGroups.delete * @memberOf! () * @@ -43071,7 +43513,7 @@ export namespace compute_v1 { /** * compute.nodeGroups.deleteNodes - * @desc Deletes specified nodes from the node group. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes specified nodes from the node group. * @alias compute.nodeGroups.deleteNodes * @memberOf! () * @@ -43149,7 +43591,7 @@ export namespace compute_v1 { /** * compute.nodeGroups.get - * @desc Returns the specified NodeGroup. Get a list of available NodeGroups by making a list() request. Note: the "nodes" field should not be used. Use nodeGroups.listNodes instead. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified NodeGroup. Get a list of available NodeGroups by making a list() request. Note: the "nodes" field should not be used. Use nodeGroups.listNodes instead. * @alias compute.nodeGroups.get * @memberOf! () * @@ -43224,7 +43666,7 @@ export namespace compute_v1 { /** * compute.nodeGroups.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.nodeGroups.getIamPolicy * @memberOf! () * @@ -43298,7 +43740,7 @@ export namespace compute_v1 { /** * compute.nodeGroups.insert - * @desc Creates a NodeGroup resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a NodeGroup resource in the specified project using the data included in the request. * @alias compute.nodeGroups.insert * @memberOf! () * @@ -43375,7 +43817,7 @@ export namespace compute_v1 { /** * compute.nodeGroups.list - * @desc Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group. * @alias compute.nodeGroups.list * @memberOf! () * @@ -43452,7 +43894,7 @@ export namespace compute_v1 { /** * compute.nodeGroups.listNodes - * @desc Lists nodes in the node group. (== suppress_warning http-rest-shadowed ==) + * @desc Lists nodes in the node group. * @alias compute.nodeGroups.listNodes * @memberOf! () * @@ -43532,7 +43974,7 @@ export namespace compute_v1 { /** * compute.nodeGroups.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.nodeGroups.setIamPolicy * @memberOf! () * @@ -43607,7 +44049,7 @@ export namespace compute_v1 { /** * compute.nodeGroups.setNodeTemplate - * @desc Updates the node template of the node group. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the node template of the node group. * @alias compute.nodeGroups.setNodeTemplate * @memberOf! () * @@ -43685,7 +44127,7 @@ export namespace compute_v1 { /** * compute.nodeGroups.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.nodeGroups.testIamPermissions * @memberOf! () * @@ -44098,7 +44540,7 @@ export namespace compute_v1 { /** * compute.nodeTemplates.aggregatedList - * @desc Retrieves an aggregated list of node templates. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of node templates. * @alias compute.nodeTemplates.aggregatedList * @memberOf! () * @@ -44183,7 +44625,7 @@ export namespace compute_v1 { /** * compute.nodeTemplates.delete - * @desc Deletes the specified NodeTemplate resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified NodeTemplate resource. * @alias compute.nodeTemplates.delete * @memberOf! () * @@ -44260,7 +44702,7 @@ export namespace compute_v1 { /** * compute.nodeTemplates.get - * @desc Returns the specified node template. Gets a list of available node templates by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified node template. Gets a list of available node templates by making a list() request. * @alias compute.nodeTemplates.get * @memberOf! () * @@ -44336,7 +44778,7 @@ export namespace compute_v1 { /** * compute.nodeTemplates.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.nodeTemplates.getIamPolicy * @memberOf! () * @@ -44410,7 +44852,7 @@ export namespace compute_v1 { /** * compute.nodeTemplates.insert - * @desc Creates a NodeTemplate resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a NodeTemplate resource in the specified project using the data included in the request. * @alias compute.nodeTemplates.insert * @memberOf! () * @@ -44487,7 +44929,7 @@ export namespace compute_v1 { /** * compute.nodeTemplates.list - * @desc Retrieves a list of node templates available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of node templates available to the specified project. * @alias compute.nodeTemplates.list * @memberOf! () * @@ -44566,7 +45008,7 @@ export namespace compute_v1 { /** * compute.nodeTemplates.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.nodeTemplates.setIamPolicy * @memberOf! () * @@ -44641,7 +45083,7 @@ export namespace compute_v1 { /** * compute.nodeTemplates.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.nodeTemplates.testIamPermissions * @memberOf! () * @@ -44929,7 +45371,7 @@ export namespace compute_v1 { /** * compute.nodeTypes.aggregatedList - * @desc Retrieves an aggregated list of node types. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of node types. * @alias compute.nodeTypes.aggregatedList * @memberOf! () * @@ -45010,7 +45452,7 @@ export namespace compute_v1 { /** * compute.nodeTypes.get - * @desc Returns the specified node type. Gets a list of available node types by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified node type. Gets a list of available node types by making a list() request. * @alias compute.nodeTypes.get * @memberOf! () * @@ -45083,7 +45525,7 @@ export namespace compute_v1 { /** * compute.nodeTypes.list - * @desc Retrieves a list of node types available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of node types available to the specified project. * @alias compute.nodeTypes.list * @memberOf! () * @@ -45246,7 +45688,7 @@ export namespace compute_v1 { /** * compute.projects.disableXpnHost - * @desc Disable this project as a shared VPC host project. (== suppress_warning http-rest-shadowed ==) + * @desc Disable this project as a shared VPC host project. * @example * * // BEFORE RUNNING: * // --------------- @@ -45370,7 +45812,7 @@ export namespace compute_v1 { /** * compute.projects.disableXpnResource - * @desc Disable a service resource (also known as service project) associated with this host project. (== suppress_warning http-rest-shadowed ==) + * @desc Disable a service resource (also known as service project) associated with this host project. * @example * * // BEFORE RUNNING: * // --------------- @@ -45499,7 +45941,7 @@ export namespace compute_v1 { /** * compute.projects.enableXpnHost - * @desc Enable this project as a shared VPC host project. (== suppress_warning http-rest-shadowed ==) + * @desc Enable this project as a shared VPC host project. * @example * * // BEFORE RUNNING: * // --------------- @@ -45623,7 +46065,7 @@ export namespace compute_v1 { /** * compute.projects.enableXpnResource - * @desc Enable service resource (a.k.a service project) for a host project, so that subnets in the host project can be used by instances in the service project. (== suppress_warning http-rest-shadowed ==) + * @desc Enable service resource (a.k.a service project) for a host project, so that subnets in the host project can be used by instances in the service project. * @example * * // BEFORE RUNNING: * // --------------- @@ -45752,7 +46194,7 @@ export namespace compute_v1 { /** * compute.projects.get - * @desc Returns the specified Project resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified Project resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -45873,7 +46315,7 @@ export namespace compute_v1 { /** * compute.projects.getXpnHost - * @desc Gets the shared VPC host project that this project links to. May be empty if no link exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the shared VPC host project that this project links to. May be empty if no link exists. * @example * * // BEFORE RUNNING: * // --------------- @@ -45994,7 +46436,7 @@ export namespace compute_v1 { /** * compute.projects.getXpnResources - * @desc Gets service resources (a.k.a service project) associated with this host project. (== suppress_warning http-rest-shadowed ==) + * @desc Gets service resources (a.k.a service project) associated with this host project. * @example * * // BEFORE RUNNING: * // --------------- @@ -46138,7 +46580,7 @@ export namespace compute_v1 { /** * compute.projects.listXpnHosts - * @desc Lists all shared VPC host projects visible to the user in an organization. (== suppress_warning http-rest-shadowed ==) + * @desc Lists all shared VPC host projects visible to the user in an organization. * @example * * // BEFORE RUNNING: * // --------------- @@ -46283,7 +46725,7 @@ export namespace compute_v1 { /** * compute.projects.moveDisk - * @desc Moves a persistent disk from one zone to another. (== suppress_warning http-rest-shadowed ==) + * @desc Moves a persistent disk from one zone to another. * @example * * // BEFORE RUNNING: * // --------------- @@ -46413,7 +46855,7 @@ export namespace compute_v1 { /** * compute.projects.moveInstance - * @desc Moves an instance and its attached persistent disks from one zone to another. (== suppress_warning http-rest-shadowed ==) + * @desc Moves an instance and its attached persistent disks from one zone to another. * @example * * // BEFORE RUNNING: * // --------------- @@ -46542,7 +46984,7 @@ export namespace compute_v1 { /** * compute.projects.setCommonInstanceMetadata - * @desc Sets metadata common to all instances within the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Sets metadata common to all instances within the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -46674,7 +47116,7 @@ export namespace compute_v1 { /** * compute.projects.setDefaultNetworkTier - * @desc Sets the default network tier of the project. The default network tier is used when an address/forwardingRule/instance is created without specifying the network tier field. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the default network tier of the project. The default network tier is used when an address/forwardingRule/instance is created without specifying the network tier field. * @alias compute.projects.setDefaultNetworkTier * @memberOf! () * @@ -46751,7 +47193,7 @@ export namespace compute_v1 { /** * compute.projects.setUsageExportBucket - * @desc Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled. (== suppress_warning http-rest-shadowed ==) + * @desc Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled. * @example * * // BEFORE RUNNING: * // --------------- @@ -47153,7 +47595,7 @@ export namespace compute_v1 { /** * compute.regionAutoscalers.delete - * @desc Deletes the specified autoscaler. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified autoscaler. * @example * * // BEFORE RUNNING: * // --------------- @@ -47286,7 +47728,7 @@ export namespace compute_v1 { /** * compute.regionAutoscalers.get - * @desc Returns the specified autoscaler. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified autoscaler. * @example * * // BEFORE RUNNING: * // --------------- @@ -47418,7 +47860,7 @@ export namespace compute_v1 { /** * compute.regionAutoscalers.insert - * @desc Creates an autoscaler in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates an autoscaler in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -47552,7 +47994,7 @@ export namespace compute_v1 { /** * compute.regionAutoscalers.list - * @desc Retrieves a list of autoscalers contained within the specified region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of autoscalers contained within the specified region. * @example * * // BEFORE RUNNING: * // --------------- @@ -47699,7 +48141,7 @@ export namespace compute_v1 { /** * compute.regionAutoscalers.patch - * @desc Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- @@ -47835,7 +48277,7 @@ export namespace compute_v1 { /** * compute.regionAutoscalers.update - * @desc Updates an autoscaler in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Updates an autoscaler in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -48138,7 +48580,7 @@ export namespace compute_v1 { /** * compute.regionBackendServices.delete - * @desc Deletes the specified regional BackendService resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified regional BackendService resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -48271,7 +48713,7 @@ export namespace compute_v1 { /** * compute.regionBackendServices.get - * @desc Returns the specified regional BackendService resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified regional BackendService resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -48403,7 +48845,7 @@ export namespace compute_v1 { /** * compute.regionBackendServices.getHealth - * @desc Gets the most recent health check results for this regional BackendService. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the most recent health check results for this regional BackendService. * @example * * // BEFORE RUNNING: * // --------------- @@ -48546,7 +48988,7 @@ export namespace compute_v1 { /** * compute.regionBackendServices.insert - * @desc Creates a regional BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a regional backend service. Read Restrictions and Guidelines for more information. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a regional BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a regional backend service. Read Restrictions and Guidelines for more information. * @example * * // BEFORE RUNNING: * // --------------- @@ -48680,7 +49122,7 @@ export namespace compute_v1 { /** * compute.regionBackendServices.list - * @desc Retrieves the list of regional BackendService resources available to the specified project in the given region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of regional BackendService resources available to the specified project in the given region. * @example * * // BEFORE RUNNING: * // --------------- @@ -48825,7 +49267,7 @@ export namespace compute_v1 { /** * compute.regionBackendServices.patch - * @desc Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- @@ -48964,7 +49406,7 @@ export namespace compute_v1 { /** * compute.regionBackendServices.update - * @desc Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. * @example * * // BEFORE RUNNING: * // --------------- @@ -49295,7 +49737,7 @@ export namespace compute_v1 { /** * compute.regionCommitments.aggregatedList - * @desc Retrieves an aggregated list of commitments. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of commitments. * @example * * // BEFORE RUNNING: * // --------------- @@ -49439,7 +49881,7 @@ export namespace compute_v1 { /** * compute.regionCommitments.get - * @desc Returns the specified commitment resource. Gets a list of available commitments by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified commitment resource. Gets a list of available commitments by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -49571,7 +50013,7 @@ export namespace compute_v1 { /** * compute.regionCommitments.insert - * @desc Creates a commitment in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a commitment in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -49705,7 +50147,7 @@ export namespace compute_v1 { /** * compute.regionCommitments.list - * @desc Retrieves a list of commitments contained within the specified region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of commitments contained within the specified region. * @example * * // BEFORE RUNNING: * // --------------- @@ -49963,7 +50405,7 @@ export namespace compute_v1 { /** * compute.regionDisks.addResourcePolicies - * @desc Adds existing resource policies to a regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation. (== suppress_warning http-rest-shadowed ==) + * @desc Adds existing resource policies to a regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation. * @alias compute.regionDisks.addResourcePolicies * @memberOf! () * @@ -50041,7 +50483,7 @@ export namespace compute_v1 { /** * compute.regionDisks.createSnapshot - * @desc Creates a snapshot of this regional disk. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a snapshot of this regional disk. * @alias compute.regionDisks.createSnapshot * @memberOf! () * @@ -50119,7 +50561,7 @@ export namespace compute_v1 { /** * compute.regionDisks.delete - * @desc Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. * @alias compute.regionDisks.delete * @memberOf! () * @@ -50196,7 +50638,7 @@ export namespace compute_v1 { /** * compute.regionDisks.get - * @desc Returns a specified regional persistent disk. (== suppress_warning http-rest-shadowed ==) + * @desc Returns a specified regional persistent disk. * @alias compute.regionDisks.get * @memberOf! () * @@ -50269,7 +50711,7 @@ export namespace compute_v1 { /** * compute.regionDisks.insert - * @desc Creates a persistent regional disk in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a persistent regional disk in the specified project using the data included in the request. * @alias compute.regionDisks.insert * @memberOf! () * @@ -50346,7 +50788,7 @@ export namespace compute_v1 { /** * compute.regionDisks.list - * @desc Retrieves the list of persistent disks contained within the specified region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of persistent disks contained within the specified region. * @alias compute.regionDisks.list * @memberOf! () * @@ -50421,7 +50863,7 @@ export namespace compute_v1 { /** * compute.regionDisks.removeResourcePolicies - * @desc Removes resource policies from a regional disk. (== suppress_warning http-rest-shadowed ==) + * @desc Removes resource policies from a regional disk. * @alias compute.regionDisks.removeResourcePolicies * @memberOf! () * @@ -50501,7 +50943,7 @@ export namespace compute_v1 { /** * compute.regionDisks.resize - * @desc Resizes the specified regional persistent disk. (== suppress_warning http-rest-shadowed ==) + * @desc Resizes the specified regional persistent disk. * @alias compute.regionDisks.resize * @memberOf! () * @@ -50579,7 +51021,7 @@ export namespace compute_v1 { /** * compute.regionDisks.setLabels - * @desc Sets the labels on the target regional disk. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the labels on the target regional disk. * @alias compute.regionDisks.setLabels * @memberOf! () * @@ -50657,7 +51099,7 @@ export namespace compute_v1 { /** * compute.regionDisks.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.regionDisks.testIamPermissions * @memberOf! () * @@ -51019,7 +51461,7 @@ export namespace compute_v1 { /** * compute.regionDiskTypes.get - * @desc Returns the specified regional disk type. Gets a list of available disk types by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified regional disk type. Gets a list of available disk types by making a list() request. * @alias compute.regionDiskTypes.get * @memberOf! () * @@ -51093,7 +51535,7 @@ export namespace compute_v1 { /** * compute.regionDiskTypes.list - * @desc Retrieves a list of regional disk types available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of regional disk types available to the specified project. * @alias compute.regionDiskTypes.list * @memberOf! () * @@ -51232,7 +51674,7 @@ export namespace compute_v1 { /** * compute.regionHealthChecks.delete - * @desc Deletes the specified HealthCheck resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified HealthCheck resource. * @alias compute.regionHealthChecks.delete * @memberOf! () * @@ -51309,7 +51751,7 @@ export namespace compute_v1 { /** * compute.regionHealthChecks.get - * @desc Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. * @alias compute.regionHealthChecks.get * @memberOf! () * @@ -51385,7 +51827,7 @@ export namespace compute_v1 { /** * compute.regionHealthChecks.insert - * @desc Creates a HealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a HealthCheck resource in the specified project using the data included in the request. * @alias compute.regionHealthChecks.insert * @memberOf! () * @@ -51462,7 +51904,7 @@ export namespace compute_v1 { /** * compute.regionHealthChecks.list - * @desc Retrieves the list of HealthCheck resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of HealthCheck resources available to the specified project. * @alias compute.regionHealthChecks.list * @memberOf! () * @@ -51541,7 +51983,7 @@ export namespace compute_v1 { /** * compute.regionHealthChecks.patch - * @desc Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.regionHealthChecks.patch * @memberOf! () * @@ -51619,7 +52061,7 @@ export namespace compute_v1 { /** * compute.regionHealthChecks.update - * @desc Updates a HealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. * @alias compute.regionHealthChecks.update * @memberOf! () * @@ -51864,7 +52306,7 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.abandonInstances - * @desc Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. (== suppress_warning http-rest-shadowed ==) + * @desc Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @example * * // BEFORE RUNNING: * // --------------- @@ -52000,9 +52442,87 @@ export namespace compute_v1 { } } + /** + * compute.regionInstanceGroupManagers.createInstances + * @desc Creates instances with per-instance configs in this regional managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method. + * @alias compute.regionInstanceGroupManagers.createInstances + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroupManager The name of the managed instance group. It should conform to RFC1035. + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region where the managed instance group is located. It should conform to 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. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().RegionInstanceGroupManagersCreateInstancesRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + createInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Createinstances, + options?: MethodOptions + ): GaxiosPromise; + createInstances( + params: Params$Resource$Regioninstancegroupmanagers$Createinstances, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + createInstances( + params: Params$Resource$Regioninstancegroupmanagers$Createinstances, + callback: BodyResponseCallback + ): void; + createInstances(callback: BodyResponseCallback): void; + createInstances( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Createinstances + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Createinstances; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroupmanagers$Createinstances; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/createInstances' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * compute.regionInstanceGroupManagers.delete - * @desc Deletes the specified managed instance group and all of the instances in that group. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified managed instance group and all of the instances in that group. * @example * * // BEFORE RUNNING: * // --------------- @@ -52135,7 +52655,7 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.deleteInstances - * @desc Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. (== suppress_warning http-rest-shadowed ==) + * @desc Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @example * * // BEFORE RUNNING: * // --------------- @@ -52273,7 +52793,7 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.get - * @desc Returns all of the details about the specified managed instance group. (== suppress_warning http-rest-shadowed ==) + * @desc Returns all of the details about the specified managed instance group. * @example * * // BEFORE RUNNING: * // --------------- @@ -52407,7 +52927,7 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.insert - * @desc Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A regional managed instance group can contain up to 2000 instances. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A regional managed instance group can contain up to 2000 instances. * @example * * // BEFORE RUNNING: * // --------------- @@ -52541,7 +53061,7 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.list - * @desc Retrieves the list of managed instance groups that are contained within the specified region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of managed instance groups that are contained within the specified region. * @example * * // BEFORE RUNNING: * // --------------- @@ -52695,7 +53215,7 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.listManagedInstances - * @desc Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. (== suppress_warning http-rest-shadowed ==) + * @desc Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. * @example * * // BEFORE RUNNING: * // --------------- @@ -52855,7 +53375,7 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.patch - * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @alias compute.regionInstanceGroupManagers.patch * @memberOf! () * @@ -52933,7 +53453,7 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.recreateInstances - * @desc Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. (== suppress_warning http-rest-shadowed ==) + * @desc Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @example * * // BEFORE RUNNING: * // --------------- @@ -53071,7 +53591,7 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.resize - * @desc Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. (== suppress_warning http-rest-shadowed ==) + * @desc Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. * @example * * // BEFORE RUNNING: * // --------------- @@ -53208,7 +53728,7 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.setInstanceTemplate - * @desc Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected. * @example * * // BEFORE RUNNING: * // --------------- @@ -53346,7 +53866,7 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.setTargetPools - * @desc Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected. (== suppress_warning http-rest-shadowed ==) + * @desc Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected. * @example * * // BEFORE RUNNING: * // --------------- @@ -53512,6 +54032,35 @@ export namespace compute_v1 { */ requestBody?: Schema$RegionInstanceGroupManagersAbandonInstancesRequest; } + export interface Params$Resource$Regioninstancegroupmanagers$Createinstances + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the managed instance group. It should conform to RFC1035. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region where the managed instance group is located. It should conform to RFC1035. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupManagersCreateInstancesRequest; + } export interface Params$Resource$Regioninstancegroupmanagers$Delete extends StandardParameters { /** @@ -53831,7 +54380,7 @@ export namespace compute_v1 { /** * compute.regionInstanceGroups.get - * @desc Returns the specified instance group resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified instance group resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -53963,7 +54512,7 @@ export namespace compute_v1 { /** * compute.regionInstanceGroups.list - * @desc Retrieves the list of instance group resources contained within the specified region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of instance group resources contained within the specified region. * @example * * // BEFORE RUNNING: * // --------------- @@ -54110,7 +54659,7 @@ export namespace compute_v1 { /** * compute.regionInstanceGroups.listInstances - * @desc Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. (== suppress_warning http-rest-shadowed ==) + * @desc Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. * @example * * // BEFORE RUNNING: * // --------------- @@ -54273,7 +54822,7 @@ export namespace compute_v1 { /** * compute.regionInstanceGroups.setNamedPorts - * @desc Sets the named ports for the specified regional instance group. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the named ports for the specified regional instance group. * @example * * // BEFORE RUNNING: * // --------------- @@ -54541,7 +55090,7 @@ export namespace compute_v1 { /** * compute.regionOperations.delete - * @desc Deletes the specified region-specific Operations resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified region-specific Operations resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -54668,7 +55217,7 @@ export namespace compute_v1 { /** * compute.regionOperations.get - * @desc Retrieves the specified region-specific Operations resource. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the specified region-specific Operations resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -54800,7 +55349,7 @@ export namespace compute_v1 { /** * compute.regionOperations.list - * @desc Retrieves a list of Operation resources contained within the specified region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of Operation resources contained within the specified region. * @example * * // BEFORE RUNNING: * // --------------- @@ -54942,6 +55491,82 @@ export namespace compute_v1 { return createAPIRequest(parameters); } } + + /** + * compute.regionOperations.wait + * @desc Waits for the specified region-specific Operations resource until it is done or timeout, and retrieves the specified Operations resource. 1. Immediately returns when the operation is already done. 2. Waits for no more than the default deadline (2 minutes, subject to change) and then returns the current state of the operation, which may be DONE or still in progress. 3. Is best-effort: a. The server can wait less than the default deadline or zero seconds, in overload situations. b. There is no guarantee that the operation is actually done when returns. 4. User should be prepared to retry if the operation is not DONE. + * @alias compute.regionOperations.wait + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.operation Name of the Operations resource to return. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + wait( + params?: Params$Resource$Regionoperations$Wait, + options?: MethodOptions + ): GaxiosPromise; + wait( + params: Params$Resource$Regionoperations$Wait, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Regionoperations$Wait, + callback: BodyResponseCallback + ): void; + wait(callback: BodyResponseCallback): void; + wait( + paramsOrCallback?: + | Params$Resource$Regionoperations$Wait + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionoperations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionoperations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/operations/{operation}/wait' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'operation'], + pathParams: ['operation', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Regionoperations$Delete @@ -55016,6 +55641,26 @@ export namespace compute_v1 { */ region?: string; } + export interface Params$Resource$Regionoperations$Wait + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the Operations resource to return. + */ + operation?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + } export class Resource$Regions { context: APIRequestContext; @@ -55025,7 +55670,7 @@ export namespace compute_v1 { /** * compute.regions.get - * @desc Returns the specified Region resource. Gets a list of available regions by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified Region resource. Gets a list of available regions by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -55149,7 +55794,7 @@ export namespace compute_v1 { /** * compute.regions.list - * @desc Retrieves the list of region resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of region resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -55339,7 +55984,7 @@ export namespace compute_v1 { /** * compute.regionSslCertificates.delete - * @desc Deletes the specified SslCertificate resource in the region. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified SslCertificate resource in the region. * @alias compute.regionSslCertificates.delete * @memberOf! () * @@ -55416,7 +56061,7 @@ export namespace compute_v1 { /** * compute.regionSslCertificates.get - * @desc Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request. * @alias compute.regionSslCertificates.get * @memberOf! () * @@ -55492,7 +56137,7 @@ export namespace compute_v1 { /** * compute.regionSslCertificates.insert - * @desc Creates a SslCertificate resource in the specified project and region using the data included in the request (== suppress_warning http-rest-shadowed ==) + * @desc Creates a SslCertificate resource in the specified project and region using the data included in the request * @alias compute.regionSslCertificates.insert * @memberOf! () * @@ -55569,7 +56214,7 @@ export namespace compute_v1 { /** * compute.regionSslCertificates.list - * @desc Retrieves the list of SslCertificate resources available to the specified project in the specified region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of SslCertificate resources available to the specified project in the specified region. * @alias compute.regionSslCertificates.list * @memberOf! () * @@ -55757,7 +56402,7 @@ export namespace compute_v1 { /** * compute.regionTargetHttpProxies.delete - * @desc Deletes the specified TargetHttpProxy resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified TargetHttpProxy resource. * @alias compute.regionTargetHttpProxies.delete * @memberOf! () * @@ -55834,7 +56479,7 @@ export namespace compute_v1 { /** * compute.regionTargetHttpProxies.get - * @desc Returns the specified TargetHttpProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified TargetHttpProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request. * @alias compute.regionTargetHttpProxies.get * @memberOf! () * @@ -55910,7 +56555,7 @@ export namespace compute_v1 { /** * compute.regionTargetHttpProxies.insert - * @desc Creates a TargetHttpProxy resource in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a TargetHttpProxy resource in the specified project and region using the data included in the request. * @alias compute.regionTargetHttpProxies.insert * @memberOf! () * @@ -55987,7 +56632,7 @@ export namespace compute_v1 { /** * compute.regionTargetHttpProxies.list - * @desc Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region. * @alias compute.regionTargetHttpProxies.list * @memberOf! () * @@ -56066,7 +56711,7 @@ export namespace compute_v1 { /** * compute.regionTargetHttpProxies.setUrlMap - * @desc Changes the URL map for TargetHttpProxy. (== suppress_warning http-rest-shadowed ==) + * @desc Changes the URL map for TargetHttpProxy. * @alias compute.regionTargetHttpProxies.setUrlMap * @memberOf! () * @@ -56282,7 +56927,7 @@ export namespace compute_v1 { /** * compute.regionTargetHttpsProxies.delete - * @desc Deletes the specified TargetHttpsProxy resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified TargetHttpsProxy resource. * @alias compute.regionTargetHttpsProxies.delete * @memberOf! () * @@ -56359,7 +57004,7 @@ export namespace compute_v1 { /** * compute.regionTargetHttpsProxies.get - * @desc Returns the specified TargetHttpsProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified TargetHttpsProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request. * @alias compute.regionTargetHttpsProxies.get * @memberOf! () * @@ -56435,7 +57080,7 @@ export namespace compute_v1 { /** * compute.regionTargetHttpsProxies.insert - * @desc Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request. * @alias compute.regionTargetHttpsProxies.insert * @memberOf! () * @@ -56512,7 +57157,7 @@ export namespace compute_v1 { /** * compute.regionTargetHttpsProxies.list - * @desc Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region. * @alias compute.regionTargetHttpsProxies.list * @memberOf! () * @@ -56593,7 +57238,7 @@ export namespace compute_v1 { /** * compute.regionTargetHttpsProxies.setSslCertificates - * @desc Replaces SslCertificates for TargetHttpsProxy. (== suppress_warning http-rest-shadowed ==) + * @desc Replaces SslCertificates for TargetHttpsProxy. * @alias compute.regionTargetHttpsProxies.setSslCertificates * @memberOf! () * @@ -56671,7 +57316,7 @@ export namespace compute_v1 { /** * compute.regionTargetHttpsProxies.setUrlMap - * @desc Changes the URL map for TargetHttpsProxy. (== suppress_warning http-rest-shadowed ==) + * @desc Changes the URL map for TargetHttpsProxy. * @alias compute.regionTargetHttpsProxies.setUrlMap * @memberOf! () * @@ -56916,7 +57561,7 @@ export namespace compute_v1 { /** * compute.regionUrlMaps.delete - * @desc Deletes the specified UrlMap resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified UrlMap resource. * @alias compute.regionUrlMaps.delete * @memberOf! () * @@ -56993,7 +57638,7 @@ export namespace compute_v1 { /** * compute.regionUrlMaps.get - * @desc Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request. * @alias compute.regionUrlMaps.get * @memberOf! () * @@ -57067,7 +57712,7 @@ export namespace compute_v1 { /** * compute.regionUrlMaps.insert - * @desc Creates a UrlMap resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a UrlMap resource in the specified project using the data included in the request. * @alias compute.regionUrlMaps.insert * @memberOf! () * @@ -57144,7 +57789,7 @@ export namespace compute_v1 { /** * compute.regionUrlMaps.list - * @desc Retrieves the list of UrlMap resources available to the specified project in the specified region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of UrlMap resources available to the specified project in the specified region. * @alias compute.regionUrlMaps.list * @memberOf! () * @@ -57223,7 +57868,7 @@ export namespace compute_v1 { /** * compute.regionUrlMaps.patch - * @desc Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. * @alias compute.regionUrlMaps.patch * @memberOf! () * @@ -57301,7 +57946,7 @@ export namespace compute_v1 { /** * compute.regionUrlMaps.update - * @desc Updates the specified UrlMap resource with the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified UrlMap resource with the data included in the request. * @alias compute.regionUrlMaps.update * @memberOf! () * @@ -57379,7 +58024,7 @@ export namespace compute_v1 { /** * compute.regionUrlMaps.validate - * @desc Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap. (== suppress_warning http-rest-shadowed ==) + * @desc Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap. * @alias compute.regionUrlMaps.validate * @memberOf! () * @@ -57652,7 +58297,7 @@ export namespace compute_v1 { /** * compute.reservations.aggregatedList - * @desc Retrieves an aggregated list of reservations. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of reservations. * @alias compute.reservations.aggregatedList * @memberOf! () * @@ -57736,7 +58381,7 @@ export namespace compute_v1 { /** * compute.reservations.delete - * @desc Deletes the specified reservation. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified reservation. * @alias compute.reservations.delete * @memberOf! () * @@ -57813,7 +58458,7 @@ export namespace compute_v1 { /** * compute.reservations.get - * @desc Retrieves information about the specified reservation. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves information about the specified reservation. * @alias compute.reservations.get * @memberOf! () * @@ -57888,7 +58533,7 @@ export namespace compute_v1 { /** * compute.reservations.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.reservations.getIamPolicy * @memberOf! () * @@ -57962,7 +58607,7 @@ export namespace compute_v1 { /** * compute.reservations.insert - * @desc Creates a new reservation. For more information, read Reserving zonal resources. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a new reservation. For more information, read Reserving zonal resources. * @alias compute.reservations.insert * @memberOf! () * @@ -58039,7 +58684,7 @@ export namespace compute_v1 { /** * compute.reservations.list - * @desc A list of all the reservations that have been configured for the specified project in specified zone. (== suppress_warning http-rest-shadowed ==) + * @desc A list of all the reservations that have been configured for the specified project in specified zone. * @alias compute.reservations.list * @memberOf! () * @@ -58118,7 +58763,7 @@ export namespace compute_v1 { /** * compute.reservations.resize - * @desc Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations. (== suppress_warning http-rest-shadowed ==) + * @desc Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations. * @alias compute.reservations.resize * @memberOf! () * @@ -58196,7 +58841,7 @@ export namespace compute_v1 { /** * compute.reservations.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.reservations.setIamPolicy * @memberOf! () * @@ -58271,7 +58916,7 @@ export namespace compute_v1 { /** * compute.reservations.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.reservations.testIamPermissions * @memberOf! () * @@ -58587,7 +59232,7 @@ export namespace compute_v1 { /** * compute.resourcePolicies.aggregatedList - * @desc Retrieves an aggregated list of resource policies. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of resource policies. * @alias compute.resourcePolicies.aggregatedList * @memberOf! () * @@ -58674,7 +59319,7 @@ export namespace compute_v1 { /** * compute.resourcePolicies.delete - * @desc Deletes the specified resource policy. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified resource policy. * @alias compute.resourcePolicies.delete * @memberOf! () * @@ -58751,7 +59396,7 @@ export namespace compute_v1 { /** * compute.resourcePolicies.get - * @desc Retrieves all information of the specified resource policy. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves all information of the specified resource policy. * @alias compute.resourcePolicies.get * @memberOf! () * @@ -58827,7 +59472,7 @@ export namespace compute_v1 { /** * compute.resourcePolicies.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.resourcePolicies.getIamPolicy * @memberOf! () * @@ -58901,7 +59546,7 @@ export namespace compute_v1 { /** * compute.resourcePolicies.insert - * @desc Creates a new resource policy. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a new resource policy. * @alias compute.resourcePolicies.insert * @memberOf! () * @@ -58978,7 +59623,7 @@ export namespace compute_v1 { /** * compute.resourcePolicies.list - * @desc A list all the resource policies that have been configured for the specified project in specified region. (== suppress_warning http-rest-shadowed ==) + * @desc A list all the resource policies that have been configured for the specified project in specified region. * @alias compute.resourcePolicies.list * @memberOf! () * @@ -59057,7 +59702,7 @@ export namespace compute_v1 { /** * compute.resourcePolicies.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.resourcePolicies.setIamPolicy * @memberOf! () * @@ -59132,7 +59777,7 @@ export namespace compute_v1 { /** * compute.resourcePolicies.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.resourcePolicies.testIamPermissions * @memberOf! () * @@ -59420,7 +60065,7 @@ export namespace compute_v1 { /** * compute.routers.aggregatedList - * @desc Retrieves an aggregated list of routers. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of routers. * @example * * // BEFORE RUNNING: * // --------------- @@ -59564,7 +60209,7 @@ export namespace compute_v1 { /** * compute.routers.delete - * @desc Deletes the specified Router resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified Router resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -59696,7 +60341,7 @@ export namespace compute_v1 { /** * compute.routers.get - * @desc Returns the specified Router resource. Gets a list of available routers by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified Router resource. Gets a list of available routers by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -59825,7 +60470,7 @@ export namespace compute_v1 { /** * compute.routers.getNatMappingInfo - * @desc Retrieves runtime Nat mapping information of VM endpoints. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves runtime Nat mapping information of VM endpoints. * @alias compute.routers.getNatMappingInfo * @memberOf! () * @@ -59912,7 +60557,7 @@ export namespace compute_v1 { /** * compute.routers.getRouterStatus - * @desc Retrieves runtime information of the specified router. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves runtime information of the specified router. * @example * * // BEFORE RUNNING: * // --------------- @@ -60048,7 +60693,7 @@ export namespace compute_v1 { /** * compute.routers.insert - * @desc Creates a Router resource in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a Router resource in the specified project and region using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -60181,7 +60826,7 @@ export namespace compute_v1 { /** * compute.routers.list - * @desc Retrieves a list of Router resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of Router resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -60325,7 +60970,7 @@ export namespace compute_v1 { /** * compute.routers.patch - * @desc Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- @@ -60463,7 +61108,7 @@ export namespace compute_v1 { /** * compute.routers.preview - * @desc Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router. (== suppress_warning http-rest-shadowed ==) + * @desc Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router. * @example * * // BEFORE RUNNING: * // --------------- @@ -60603,7 +61248,7 @@ export namespace compute_v1 { /** * compute.routers.update - * @desc Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload. * @example * * // BEFORE RUNNING: * // --------------- @@ -61010,7 +61655,7 @@ export namespace compute_v1 { /** * compute.routes.delete - * @desc Deletes the specified Route resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified Route resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -61137,7 +61782,7 @@ export namespace compute_v1 { /** * compute.routes.get - * @desc Returns the specified Route resource. Gets a list of available routes by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified Route resource. Gets a list of available routes by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -61261,7 +61906,7 @@ export namespace compute_v1 { /** * compute.routes.insert - * @desc Creates a Route resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a Route resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -61389,7 +62034,7 @@ export namespace compute_v1 { /** * compute.routes.list - * @desc Retrieves the list of Route resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of Route resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -61617,7 +62262,7 @@ export namespace compute_v1 { /** * compute.securityPolicies.addRule - * @desc Inserts a rule into a security policy. (== suppress_warning http-rest-shadowed ==) + * @desc Inserts a rule into a security policy. * @alias compute.securityPolicies.addRule * @memberOf! () * @@ -61693,7 +62338,7 @@ export namespace compute_v1 { /** * compute.securityPolicies.delete - * @desc Deletes the specified policy. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified policy. * @alias compute.securityPolicies.delete * @memberOf! () * @@ -61769,7 +62414,7 @@ export namespace compute_v1 { /** * compute.securityPolicies.get - * @desc List all of the ordered rules present in a single specified policy. (== suppress_warning http-rest-shadowed ==) + * @desc List all of the ordered rules present in a single specified policy. * @alias compute.securityPolicies.get * @memberOf! () * @@ -61844,7 +62489,7 @@ export namespace compute_v1 { /** * compute.securityPolicies.getRule - * @desc Gets a rule at the specified priority. (== suppress_warning http-rest-shadowed ==) + * @desc Gets a rule at the specified priority. * @alias compute.securityPolicies.getRule * @memberOf! () * @@ -61920,7 +62565,7 @@ export namespace compute_v1 { /** * compute.securityPolicies.insert - * @desc Creates a new policy in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a new policy in the specified project using the data included in the request. * @alias compute.securityPolicies.insert * @memberOf! () * @@ -61995,7 +62640,7 @@ export namespace compute_v1 { /** * compute.securityPolicies.list - * @desc List all the policies that have been configured for the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc List all the policies that have been configured for the specified project. * @alias compute.securityPolicies.list * @memberOf! () * @@ -62072,7 +62717,7 @@ export namespace compute_v1 { /** * compute.securityPolicies.patch - * @desc Patches the specified policy with the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Patches the specified policy with the data included in the request. * @alias compute.securityPolicies.patch * @memberOf! () * @@ -62149,7 +62794,7 @@ export namespace compute_v1 { /** * compute.securityPolicies.patchRule - * @desc Patches a rule at the specified priority. (== suppress_warning http-rest-shadowed ==) + * @desc Patches a rule at the specified priority. * @alias compute.securityPolicies.patchRule * @memberOf! () * @@ -62226,7 +62871,7 @@ export namespace compute_v1 { /** * compute.securityPolicies.removeRule - * @desc Deletes a rule at the specified priority. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes a rule at the specified priority. * @alias compute.securityPolicies.removeRule * @memberOf! () * @@ -62506,7 +63151,7 @@ export namespace compute_v1 { /** * compute.snapshots.delete - * @desc Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snapshots. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snapshots. * @example * * // BEFORE RUNNING: * // --------------- @@ -62634,7 +63279,7 @@ export namespace compute_v1 { /** * compute.snapshots.get - * @desc Returns the specified Snapshot resource. Gets a list of available snapshots by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified Snapshot resource. Gets a list of available snapshots by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -62759,7 +63404,7 @@ export namespace compute_v1 { /** * compute.snapshots.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.snapshots.getIamPolicy * @memberOf! () * @@ -62832,7 +63477,7 @@ export namespace compute_v1 { /** * compute.snapshots.list - * @desc Retrieves the list of Snapshot resources contained within the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of Snapshot resources contained within the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -62971,7 +63616,7 @@ export namespace compute_v1 { /** * compute.snapshots.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.snapshots.setIamPolicy * @memberOf! () * @@ -63045,7 +63690,7 @@ export namespace compute_v1 { /** * compute.snapshots.setLabels - * @desc Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation. * @example * * // BEFORE RUNNING: * // --------------- @@ -63178,7 +63823,7 @@ export namespace compute_v1 { /** * compute.snapshots.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.snapshots.testIamPermissions * @memberOf! () * @@ -63406,7 +64051,7 @@ export namespace compute_v1 { /** * compute.sslCertificates.aggregatedList - * @desc Retrieves the list of all SslCertificate resources, regional and global, available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of all SslCertificate resources, regional and global, available to the specified project. * @alias compute.sslCertificates.aggregatedList * @memberOf! () * @@ -63493,7 +64138,7 @@ export namespace compute_v1 { /** * compute.sslCertificates.delete - * @desc Deletes the specified SslCertificate resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified SslCertificate resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -63622,7 +64267,7 @@ export namespace compute_v1 { /** * compute.sslCertificates.get - * @desc Returns the specified SslCertificate resource. Gets a list of available SSL certificates by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified SslCertificate resource. Gets a list of available SSL certificates by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -63750,7 +64395,7 @@ export namespace compute_v1 { /** * compute.sslCertificates.insert - * @desc Creates a SslCertificate resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a SslCertificate resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -63879,7 +64524,7 @@ export namespace compute_v1 { /** * compute.sslCertificates.list - * @desc Retrieves the list of SslCertificate resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of SslCertificate resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -64140,7 +64785,7 @@ export namespace compute_v1 { /** * compute.sslPolicies.delete - * @desc Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources. * @alias compute.sslPolicies.delete * @memberOf! () * @@ -64216,7 +64861,7 @@ export namespace compute_v1 { /** * compute.sslPolicies.get - * @desc Lists all of the ordered rules present in a single specified policy. (== suppress_warning http-rest-shadowed ==) + * @desc Lists all of the ordered rules present in a single specified policy. * @alias compute.sslPolicies.get * @memberOf! () * @@ -64290,7 +64935,7 @@ export namespace compute_v1 { /** * compute.sslPolicies.insert - * @desc Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() request. * @alias compute.sslPolicies.insert * @memberOf! () * @@ -64365,7 +65010,7 @@ export namespace compute_v1 { /** * compute.sslPolicies.list - * @desc Lists all the SSL policies that have been configured for the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Lists all the SSL policies that have been configured for the specified project. * @alias compute.sslPolicies.list * @memberOf! () * @@ -64441,7 +65086,7 @@ export namespace compute_v1 { /** * compute.sslPolicies.listAvailableFeatures - * @desc Lists all features that can be specified in the SSL policy when using custom profile. (== suppress_warning http-rest-shadowed ==) + * @desc Lists all features that can be specified in the SSL policy when using custom profile. * @alias compute.sslPolicies.listAvailableFeatures * @memberOf! () * @@ -64536,7 +65181,7 @@ export namespace compute_v1 { /** * compute.sslPolicies.patch - * @desc Patches the specified SSL policy with the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Patches the specified SSL policy with the data included in the request. * @alias compute.sslPolicies.patch * @memberOf! () * @@ -64757,7 +65402,7 @@ export namespace compute_v1 { /** * compute.subnetworks.aggregatedList - * @desc Retrieves an aggregated list of subnetworks. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of subnetworks. * @example * * // BEFORE RUNNING: * // --------------- @@ -64901,7 +65546,7 @@ export namespace compute_v1 { /** * compute.subnetworks.delete - * @desc Deletes the specified subnetwork. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified subnetwork. * @example * * // BEFORE RUNNING: * // --------------- @@ -65034,7 +65679,7 @@ export namespace compute_v1 { /** * compute.subnetworks.expandIpCidrRange - * @desc Expands the IP CIDR range of the subnetwork to a specified value. (== suppress_warning http-rest-shadowed ==) + * @desc Expands the IP CIDR range of the subnetwork to a specified value. * @example * * // BEFORE RUNNING: * // --------------- @@ -65172,7 +65817,7 @@ export namespace compute_v1 { /** * compute.subnetworks.get - * @desc Returns the specified subnetwork. Gets a list of available subnetworks list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified subnetwork. Gets a list of available subnetworks list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -65303,7 +65948,7 @@ export namespace compute_v1 { /** * compute.subnetworks.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. * @alias compute.subnetworks.getIamPolicy * @memberOf! () * @@ -65377,7 +66022,7 @@ export namespace compute_v1 { /** * compute.subnetworks.insert - * @desc Creates a subnetwork in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a subnetwork in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -65511,7 +66156,7 @@ export namespace compute_v1 { /** * compute.subnetworks.list - * @desc Retrieves a list of subnetworks available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of subnetworks available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -65655,7 +66300,7 @@ export namespace compute_v1 { /** * compute.subnetworks.listUsable - * @desc Retrieves an aggregated list of all usable subnetworks in the project. The list contains all of the subnetworks in the project and the subnetworks that were shared by a Shared VPC host project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of all usable subnetworks in the project. The list contains all of the subnetworks in the project and the subnetworks that were shared by a Shared VPC host project. * @alias compute.subnetworks.listUsable * @memberOf! () * @@ -65742,7 +66387,7 @@ export namespace compute_v1 { /** * compute.subnetworks.patch - * @desc Patches the specified subnetwork with the data included in the request. Only certain fields can up updated with a patch request as indicated in the field descriptions. You must specify the current fingeprint of the subnetwork resource being patched. (== suppress_warning http-rest-shadowed ==) + * @desc Patches the specified subnetwork with the data included in the request. Only certain fields can up updated with a patch request as indicated in the field descriptions. You must specify the current fingeprint of the subnetwork resource being patched. * @alias compute.subnetworks.patch * @memberOf! () * @@ -65821,7 +66466,7 @@ export namespace compute_v1 { /** * compute.subnetworks.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. * @alias compute.subnetworks.setIamPolicy * @memberOf! () * @@ -65896,7 +66541,7 @@ export namespace compute_v1 { /** * compute.subnetworks.setPrivateIpGoogleAccess - * @desc Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access. (== suppress_warning http-rest-shadowed ==) + * @desc Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access. * @example * * // BEFORE RUNNING: * // --------------- @@ -66036,7 +66681,7 @@ export namespace compute_v1 { /** * compute.subnetworks.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.subnetworks.testIamPermissions * @memberOf! () * @@ -66441,7 +67086,7 @@ export namespace compute_v1 { /** * compute.targetHttpProxies.aggregatedList - * @desc Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project. * @alias compute.targetHttpProxies.aggregatedList * @memberOf! () * @@ -66528,7 +67173,7 @@ export namespace compute_v1 { /** * compute.targetHttpProxies.delete - * @desc Deletes the specified TargetHttpProxy resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified TargetHttpProxy resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -66657,7 +67302,7 @@ export namespace compute_v1 { /** * compute.targetHttpProxies.get - * @desc Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -66785,7 +67430,7 @@ export namespace compute_v1 { /** * compute.targetHttpProxies.insert - * @desc Creates a TargetHttpProxy resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a TargetHttpProxy resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -66915,7 +67560,7 @@ export namespace compute_v1 { /** * compute.targetHttpProxies.list - * @desc Retrieves the list of TargetHttpProxy resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of TargetHttpProxy resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -67056,7 +67701,7 @@ export namespace compute_v1 { /** * compute.targetHttpProxies.setUrlMap - * @desc Changes the URL map for TargetHttpProxy. (== suppress_warning http-rest-shadowed ==) + * @desc Changes the URL map for TargetHttpProxy. * @example * * // BEFORE RUNNING: * // --------------- @@ -67336,7 +67981,7 @@ export namespace compute_v1 { /** * compute.targetHttpsProxies.aggregatedList - * @desc Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project. * @alias compute.targetHttpsProxies.aggregatedList * @memberOf! () * @@ -67423,7 +68068,7 @@ export namespace compute_v1 { /** * compute.targetHttpsProxies.delete - * @desc Deletes the specified TargetHttpsProxy resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified TargetHttpsProxy resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -67552,7 +68197,7 @@ export namespace compute_v1 { /** * compute.targetHttpsProxies.get - * @desc Returns the specified TargetHttpsProxy resource. Gets a list of available target HTTPS proxies by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified TargetHttpsProxy resource. Gets a list of available target HTTPS proxies by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -67680,7 +68325,7 @@ export namespace compute_v1 { /** * compute.targetHttpsProxies.insert - * @desc Creates a TargetHttpsProxy resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a TargetHttpsProxy resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -67810,7 +68455,7 @@ export namespace compute_v1 { /** * compute.targetHttpsProxies.list - * @desc Retrieves the list of TargetHttpsProxy resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of TargetHttpsProxy resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -67953,7 +68598,7 @@ export namespace compute_v1 { /** * compute.targetHttpsProxies.setQuicOverride - * @desc Sets the QUIC override policy for TargetHttpsProxy. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the QUIC override policy for TargetHttpsProxy. * @alias compute.targetHttpsProxies.setQuicOverride * @memberOf! () * @@ -68030,7 +68675,7 @@ export namespace compute_v1 { /** * compute.targetHttpsProxies.setSslCertificates - * @desc Replaces SslCertificates for TargetHttpsProxy. (== suppress_warning http-rest-shadowed ==) + * @desc Replaces SslCertificates for TargetHttpsProxy. * @example * * // BEFORE RUNNING: * // --------------- @@ -68164,7 +68809,7 @@ export namespace compute_v1 { /** * compute.targetHttpsProxies.setSslPolicy - * @desc Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends. * @alias compute.targetHttpsProxies.setSslPolicy * @memberOf! () * @@ -68241,7 +68886,7 @@ export namespace compute_v1 { /** * compute.targetHttpsProxies.setUrlMap - * @desc Changes the URL map for TargetHttpsProxy. (== suppress_warning http-rest-shadowed ==) + * @desc Changes the URL map for TargetHttpsProxy. * @example * * // BEFORE RUNNING: * // --------------- @@ -68596,7 +69241,7 @@ export namespace compute_v1 { /** * compute.targetInstances.aggregatedList - * @desc Retrieves an aggregated list of target instances. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of target instances. * @example * * // BEFORE RUNNING: * // --------------- @@ -68746,7 +69391,7 @@ export namespace compute_v1 { /** * compute.targetInstances.delete - * @desc Deletes the specified TargetInstance resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified TargetInstance resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -68879,7 +69524,7 @@ export namespace compute_v1 { /** * compute.targetInstances.get - * @desc Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -69011,7 +69656,7 @@ export namespace compute_v1 { /** * compute.targetInstances.insert - * @desc Creates a TargetInstance resource in the specified project and zone using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a TargetInstance resource in the specified project and zone using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -69145,7 +69790,7 @@ export namespace compute_v1 { /** * compute.targetInstances.list - * @desc Retrieves a list of TargetInstance resources available to the specified project and zone. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of TargetInstance resources available to the specified project and zone. * @example * * // BEFORE RUNNING: * // --------------- @@ -69427,7 +70072,7 @@ export namespace compute_v1 { /** * compute.targetPools.addHealthCheck - * @desc Adds health check URLs to a target pool. (== suppress_warning http-rest-shadowed ==) + * @desc Adds health check URLs to a target pool. * @example * * // BEFORE RUNNING: * // --------------- @@ -69565,7 +70210,7 @@ export namespace compute_v1 { /** * compute.targetPools.addInstance - * @desc Adds an instance to a target pool. (== suppress_warning http-rest-shadowed ==) + * @desc Adds an instance to a target pool. * @example * * // BEFORE RUNNING: * // --------------- @@ -69703,7 +70348,7 @@ export namespace compute_v1 { /** * compute.targetPools.aggregatedList - * @desc Retrieves an aggregated list of target pools. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of target pools. * @example * * // BEFORE RUNNING: * // --------------- @@ -69847,7 +70492,7 @@ export namespace compute_v1 { /** * compute.targetPools.delete - * @desc Deletes the specified target pool. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified target pool. * @example * * // BEFORE RUNNING: * // --------------- @@ -69980,7 +70625,7 @@ export namespace compute_v1 { /** * compute.targetPools.get - * @desc Returns the specified target pool. Gets a list of available target pools by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified target pool. Gets a list of available target pools by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -70111,7 +70756,7 @@ export namespace compute_v1 { /** * compute.targetPools.getHealth - * @desc Gets the most recent health check results for each IP for the instance that is referenced by the given target pool. (== suppress_warning http-rest-shadowed ==) + * @desc Gets the most recent health check results for each IP for the instance that is referenced by the given target pool. * @example * * // BEFORE RUNNING: * // --------------- @@ -70252,7 +70897,7 @@ export namespace compute_v1 { /** * compute.targetPools.insert - * @desc Creates a target pool in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a target pool in the specified project and region using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -70386,7 +71031,7 @@ export namespace compute_v1 { /** * compute.targetPools.list - * @desc Retrieves a list of target pools available to the specified project and region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of target pools available to the specified project and region. * @example * * // BEFORE RUNNING: * // --------------- @@ -70530,7 +71175,7 @@ export namespace compute_v1 { /** * compute.targetPools.removeHealthCheck - * @desc Removes health check URL from a target pool. (== suppress_warning http-rest-shadowed ==) + * @desc Removes health check URL from a target pool. * @example * * // BEFORE RUNNING: * // --------------- @@ -70668,7 +71313,7 @@ export namespace compute_v1 { /** * compute.targetPools.removeInstance - * @desc Removes instance URL from a target pool. (== suppress_warning http-rest-shadowed ==) + * @desc Removes instance URL from a target pool. * @example * * // BEFORE RUNNING: * // --------------- @@ -70806,7 +71451,7 @@ export namespace compute_v1 { /** * compute.targetPools.setBackup - * @desc Changes a backup target pool's configurations. (== suppress_warning http-rest-shadowed ==) + * @desc Changes a backup target pool's configurations. * @example * * // BEFORE RUNNING: * // --------------- @@ -71254,7 +71899,7 @@ export namespace compute_v1 { /** * compute.targetSslProxies.delete - * @desc Deletes the specified TargetSslProxy resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified TargetSslProxy resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -71383,7 +72028,7 @@ export namespace compute_v1 { /** * compute.targetSslProxies.get - * @desc Returns the specified TargetSslProxy resource. Gets a list of available target SSL proxies by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified TargetSslProxy resource. Gets a list of available target SSL proxies by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -71511,7 +72156,7 @@ export namespace compute_v1 { /** * compute.targetSslProxies.insert - * @desc Creates a TargetSslProxy resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a TargetSslProxy resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -71640,7 +72285,7 @@ export namespace compute_v1 { /** * compute.targetSslProxies.list - * @desc Retrieves the list of TargetSslProxy resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of TargetSslProxy resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -71780,7 +72425,7 @@ export namespace compute_v1 { /** * compute.targetSslProxies.setBackendService - * @desc Changes the BackendService for TargetSslProxy. (== suppress_warning http-rest-shadowed ==) + * @desc Changes the BackendService for TargetSslProxy. * @example * * // BEFORE RUNNING: * // --------------- @@ -71914,7 +72559,7 @@ export namespace compute_v1 { /** * compute.targetSslProxies.setProxyHeader - * @desc Changes the ProxyHeaderType for TargetSslProxy. (== suppress_warning http-rest-shadowed ==) + * @desc Changes the ProxyHeaderType for TargetSslProxy. * @example * * // BEFORE RUNNING: * // --------------- @@ -72048,7 +72693,7 @@ export namespace compute_v1 { /** * compute.targetSslProxies.setSslCertificates - * @desc Changes SslCertificates for TargetSslProxy. (== suppress_warning http-rest-shadowed ==) + * @desc Changes SslCertificates for TargetSslProxy. * @example * * // BEFORE RUNNING: * // --------------- @@ -72182,7 +72827,7 @@ export namespace compute_v1 { /** * compute.targetSslProxies.setSslPolicy - * @desc Sets the SSL policy for TargetSslProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the SSL proxy load balancer. They do not affect the connection between the load balancer and the backends. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the SSL policy for TargetSslProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the SSL proxy load balancer. They do not affect the connection between the load balancer and the backends. * @alias compute.targetSslProxies.setSslPolicy * @memberOf! () * @@ -72452,7 +73097,7 @@ export namespace compute_v1 { /** * compute.targetTcpProxies.delete - * @desc Deletes the specified TargetTcpProxy resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified TargetTcpProxy resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -72581,7 +73226,7 @@ export namespace compute_v1 { /** * compute.targetTcpProxies.get - * @desc Returns the specified TargetTcpProxy resource. Gets a list of available target TCP proxies by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified TargetTcpProxy resource. Gets a list of available target TCP proxies by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -72709,7 +73354,7 @@ export namespace compute_v1 { /** * compute.targetTcpProxies.insert - * @desc Creates a TargetTcpProxy resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a TargetTcpProxy resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -72838,7 +73483,7 @@ export namespace compute_v1 { /** * compute.targetTcpProxies.list - * @desc Retrieves the list of TargetTcpProxy resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of TargetTcpProxy resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -72978,7 +73623,7 @@ export namespace compute_v1 { /** * compute.targetTcpProxies.setBackendService - * @desc Changes the BackendService for TargetTcpProxy. (== suppress_warning http-rest-shadowed ==) + * @desc Changes the BackendService for TargetTcpProxy. * @example * * // BEFORE RUNNING: * // --------------- @@ -73112,7 +73757,7 @@ export namespace compute_v1 { /** * compute.targetTcpProxies.setProxyHeader - * @desc Changes the ProxyHeaderType for TargetTcpProxy. (== suppress_warning http-rest-shadowed ==) + * @desc Changes the ProxyHeaderType for TargetTcpProxy. * @example * * // BEFORE RUNNING: * // --------------- @@ -73389,7 +74034,7 @@ export namespace compute_v1 { /** * compute.targetVpnGateways.aggregatedList - * @desc Retrieves an aggregated list of target VPN gateways. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of target VPN gateways. * @example * * // BEFORE RUNNING: * // --------------- @@ -73539,7 +74184,7 @@ export namespace compute_v1 { /** * compute.targetVpnGateways.delete - * @desc Deletes the specified target VPN gateway. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified target VPN gateway. * @example * * // BEFORE RUNNING: * // --------------- @@ -73672,7 +74317,7 @@ export namespace compute_v1 { /** * compute.targetVpnGateways.get - * @desc Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -73804,7 +74449,7 @@ export namespace compute_v1 { /** * compute.targetVpnGateways.insert - * @desc Creates a target VPN gateway in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a target VPN gateway in the specified project and region using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -73938,7 +74583,7 @@ export namespace compute_v1 { /** * compute.targetVpnGateways.list - * @desc Retrieves a list of target VPN gateways available to the specified project and region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of target VPN gateways available to the specified project and region. * @example * * // BEFORE RUNNING: * // --------------- @@ -74222,7 +74867,7 @@ export namespace compute_v1 { /** * compute.urlMaps.aggregatedList - * @desc Retrieves the list of all UrlMap resources, regional and global, available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of all UrlMap resources, regional and global, available to the specified project. * @alias compute.urlMaps.aggregatedList * @memberOf! () * @@ -74303,7 +74948,7 @@ export namespace compute_v1 { /** * compute.urlMaps.delete - * @desc Deletes the specified UrlMap resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified UrlMap resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -74430,7 +75075,7 @@ export namespace compute_v1 { /** * compute.urlMaps.get - * @desc Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -74554,7 +75199,7 @@ export namespace compute_v1 { /** * compute.urlMaps.insert - * @desc Creates a UrlMap resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a UrlMap resource in the specified project using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -74682,7 +75327,7 @@ export namespace compute_v1 { /** * compute.urlMaps.invalidateCache - * @desc Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. (== suppress_warning http-rest-shadowed ==) + * @desc Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. * @example * * // BEFORE RUNNING: * // --------------- @@ -74816,7 +75461,7 @@ export namespace compute_v1 { /** * compute.urlMaps.list - * @desc Retrieves the list of UrlMap resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of UrlMap resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -74955,7 +75600,7 @@ export namespace compute_v1 { /** * compute.urlMaps.patch - * @desc Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) + * @desc Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- @@ -75088,7 +75733,7 @@ export namespace compute_v1 { /** * compute.urlMaps.update - * @desc Updates the specified UrlMap resource with the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Updates the specified UrlMap resource with the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -75221,7 +75866,7 @@ export namespace compute_v1 { /** * compute.urlMaps.validate - * @desc Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap. (== suppress_warning http-rest-shadowed ==) + * @desc Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap. * @example * * // BEFORE RUNNING: * // --------------- @@ -75567,7 +76212,7 @@ export namespace compute_v1 { /** * compute.vpnGateways.aggregatedList - * @desc Retrieves an aggregated list of VPN gateways. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of VPN gateways. * @alias compute.vpnGateways.aggregatedList * @memberOf! () * @@ -75648,7 +76293,7 @@ export namespace compute_v1 { /** * compute.vpnGateways.delete - * @desc Deletes the specified VPN gateway. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified VPN gateway. * @alias compute.vpnGateways.delete * @memberOf! () * @@ -75725,7 +76370,7 @@ export namespace compute_v1 { /** * compute.vpnGateways.get - * @desc Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request. * @alias compute.vpnGateways.get * @memberOf! () * @@ -75800,7 +76445,7 @@ export namespace compute_v1 { /** * compute.vpnGateways.getStatus - * @desc Returns the status for the specified VPN gateway. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the status for the specified VPN gateway. * @alias compute.vpnGateways.getStatus * @memberOf! () * @@ -75885,7 +76530,7 @@ export namespace compute_v1 { /** * compute.vpnGateways.insert - * @desc Creates a VPN gateway in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a VPN gateway in the specified project and region using the data included in the request. * @alias compute.vpnGateways.insert * @memberOf! () * @@ -75962,7 +76607,7 @@ export namespace compute_v1 { /** * compute.vpnGateways.list - * @desc Retrieves a list of VPN gateways available to the specified project and region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of VPN gateways available to the specified project and region. * @alias compute.vpnGateways.list * @memberOf! () * @@ -76040,7 +76685,7 @@ export namespace compute_v1 { /** * compute.vpnGateways.setLabels - * @desc Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) + * @desc Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation. * @alias compute.vpnGateways.setLabels * @memberOf! () * @@ -76118,7 +76763,7 @@ export namespace compute_v1 { /** * compute.vpnGateways.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) + * @desc Returns permissions that a caller has on the specified resource. * @alias compute.vpnGateways.testIamPermissions * @memberOf! () * @@ -76408,7 +77053,7 @@ export namespace compute_v1 { /** * compute.vpnTunnels.aggregatedList - * @desc Retrieves an aggregated list of VPN tunnels. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves an aggregated list of VPN tunnels. * @example * * // BEFORE RUNNING: * // --------------- @@ -76552,7 +77197,7 @@ export namespace compute_v1 { /** * compute.vpnTunnels.delete - * @desc Deletes the specified VpnTunnel resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified VpnTunnel resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -76685,7 +77330,7 @@ export namespace compute_v1 { /** * compute.vpnTunnels.get - * @desc Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -76816,7 +77461,7 @@ export namespace compute_v1 { /** * compute.vpnTunnels.insert - * @desc Creates a VpnTunnel resource in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) + * @desc Creates a VpnTunnel resource in the specified project and region using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -76950,7 +77595,7 @@ export namespace compute_v1 { /** * compute.vpnTunnels.list - * @desc Retrieves a list of VpnTunnel resources contained in the specified project and region. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of VpnTunnel resources contained in the specified project and region. * @example * * // BEFORE RUNNING: * // --------------- @@ -77229,7 +77874,7 @@ export namespace compute_v1 { /** * compute.zoneOperations.delete - * @desc Deletes the specified zone-specific Operations resource. (== suppress_warning http-rest-shadowed ==) + * @desc Deletes the specified zone-specific Operations resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -77356,7 +78001,7 @@ export namespace compute_v1 { /** * compute.zoneOperations.get - * @desc Retrieves the specified zone-specific Operations resource. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the specified zone-specific Operations resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -77488,7 +78133,7 @@ export namespace compute_v1 { /** * compute.zoneOperations.list - * @desc Retrieves a list of Operation resources contained within the specified zone. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves a list of Operation resources contained within the specified zone. * @example * * // BEFORE RUNNING: * // --------------- @@ -77629,6 +78274,82 @@ export namespace compute_v1 { return createAPIRequest(parameters); } } + + /** + * compute.zoneOperations.wait + * @desc Waits for the specified zone-specific Operations resource until it is done or timeout, and retrieves the specified Operations resource. 1. Immediately returns when the operation is already done. 2. Waits for no more than the default deadline (2 minutes, subject to change) and then returns the current state of the operation, which may be DONE or still in progress. 3. Is best-effort: a. The server can wait less than the default deadline or zero seconds, in overload situations. b. There is no guarantee that the operation is actually done when returns. 4. User should be prepared to retry if the operation is not DONE. + * @alias compute.zoneOperations.wait + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.operation Name of the Operations resource to return. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone Name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + wait( + params?: Params$Resource$Zoneoperations$Wait, + options?: MethodOptions + ): GaxiosPromise; + wait( + params: Params$Resource$Zoneoperations$Wait, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Zoneoperations$Wait, + callback: BodyResponseCallback + ): void; + wait(callback: BodyResponseCallback): void; + wait( + paramsOrCallback?: + | Params$Resource$Zoneoperations$Wait + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Zoneoperations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Zoneoperations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/operations/{operation}/wait' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'operation'], + pathParams: ['operation', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Zoneoperations$Delete @@ -77703,6 +78424,26 @@ export namespace compute_v1 { */ zone?: string; } + export interface Params$Resource$Zoneoperations$Wait + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the Operations resource to return. + */ + operation?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the zone for this request. + */ + zone?: string; + } export class Resource$Zones { context: APIRequestContext; @@ -77712,7 +78453,7 @@ export namespace compute_v1 { /** * compute.zones.get - * @desc Returns the specified Zone resource. Gets a list of available zones by making a list() request. (== suppress_warning http-rest-shadowed ==) + * @desc Returns the specified Zone resource. Gets a list of available zones by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -77836,7 +78577,7 @@ export namespace compute_v1 { /** * compute.zones.list - * @desc Retrieves the list of Zone resources available to the specified project. (== suppress_warning http-rest-shadowed ==) + * @desc Retrieves the list of Zone resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- diff --git a/src/apis/container/v1.ts b/src/apis/container/v1.ts index 540b47f80da..2938c9c5adb 100644 --- a/src/apis/container/v1.ts +++ b/src/apis/container/v1.ts @@ -132,6 +132,10 @@ export namespace container_v1 { * Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. */ export interface Schema$AddonsConfig { + /** + * Configuration for the Cloud Run addon, which allows the user to use a managed Knative service. + */ + cloudRunConfig?: Schema$CloudRunConfig; /** * Configuration for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods. */ @@ -215,15 +219,15 @@ export namespace container_v1 { */ name?: string | null; /** - * Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. */ operationId?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -249,6 +253,15 @@ export namespace container_v1 { */ issueClientCertificate?: boolean | null; } + /** + * Configuration options for the Cloud Run feature. + */ + export interface Schema$CloudRunConfig { + /** + * Whether Cloud Run addon is enabled for this cluster. + */ + disabled?: boolean | null; + } /** * A Google Kubernetes Engine cluster. */ @@ -541,7 +554,7 @@ export namespace container_v1 { */ export interface Schema$CompleteIPRotationRequest { /** - * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string | null; /** @@ -549,11 +562,11 @@ export namespace container_v1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -571,7 +584,7 @@ export namespace container_v1 { */ export interface Schema$CreateClusterRequest { /** - * A [cluster resource](/container-engine/reference/rest/v1/projects.zones.clusters) + * Required. A [cluster resource](/container-engine/reference/rest/v1/projects.zones.clusters) */ cluster?: Schema$Cluster; /** @@ -579,11 +592,11 @@ export namespace container_v1 { */ parent?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. */ zone?: string | null; } @@ -592,11 +605,11 @@ export namespace container_v1 { */ export interface Schema$CreateNodePoolRequest { /** - * Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. */ clusterId?: string | null; /** - * The node pool to create. + * Required. The node pool to create. */ nodePool?: Schema$NodePool; /** @@ -604,11 +617,11 @@ export namespace container_v1 { */ parent?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. */ zone?: string | null; } @@ -900,6 +913,10 @@ export namespace container_v1 { * MaintenancePolicy defines the maintenance policy to be used for the cluster. */ export interface Schema$MaintenancePolicy { + /** + * A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a <code>get()</code> request to the cluster to get the current resource version and include it with requests to set the policy. + */ + resourceVersion?: string | null; /** * Specifies the maintenance window in which maintenance may be performed. */ @@ -913,6 +930,14 @@ export namespace container_v1 { * DailyMaintenanceWindow specifies a daily maintenance operation window. */ dailyMaintenanceWindow?: Schema$DailyMaintenanceWindow; + /** + * Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. + */ + maintenanceExclusions?: {[key: string]: Schema$TimeWindow} | null; + /** + * RecurringWindow specifies some number of recurring time periods for maintenance to occur. The time windows may be overlapping. If no maintenance windows are set, maintenance can occur at any time. + */ + recurringWindow?: Schema$RecurringTimeWindow; } /** * The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. @@ -1037,7 +1062,7 @@ export namespace container_v1 { */ machineType?: string | null; /** - * The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: "cluster-location" "cluster-name" "cluster-uid" "configure-sh" "containerd-configure-sh" "enable-os-login" "gci-update-strategy" "gci-ensure-gke-docker" "instance-template" "kube-env" "startup-script" "user-data" "disable-address-manager" "windows-startup-script-ps1" "common-psm1" "k8s-node-setup-psm1" "install-ssh-psm1" "user-profile-psm1" "serial-port-logging-enable" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. + * The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: "cluster-location" "cluster-name" "cluster-uid" "configure-sh" "containerd-configure-sh" "enable-os-login" "gci-ensure-gke-docker" "gci-metrics-enabled" "gci-update-strategy" "instance-template" "kube-env" "startup-script" "user-data" "disable-address-manager" "windows-startup-script-ps1" "common-psm1" "k8s-node-setup-psm1" "install-ssh-psm1" "user-profile-psm1" "serial-port-logging-enable" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. */ metadata?: {[key: string]: string} | null; /** @@ -1052,6 +1077,10 @@ export namespace container_v1 { * Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. */ preemptible?: boolean | null; + /** + * The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](/compute/docs/instances/reserving-zonal-resources) to this node pool. + */ + reservationAffinity?: Schema$ReservationAffinity; /** * The Google Cloud Platform Service Account to be used by the node VMs. If no Service Account is specified, the "default" service account is used. */ @@ -1263,6 +1292,36 @@ export namespace container_v1 { */ publicEndpoint?: string | null; } + /** + * Represents an arbitrary window of time that recurs. + */ + export interface Schema$RecurringTimeWindow { + /** + * An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window reccurs. They go on for the span of time between the start and end time. For example, to have something repeat every weekday, you'd use: <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code> To repeat some window daily (equivalent to the DailyMaintenanceWindow): <code>FREQ=DAILY</code> For the first weekend of every month: <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code> This specifies how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you'd use something like: <code> start time = 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR </code> Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC: <code> start time = 2019-01-05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence = FREQ=WEEKLY;BYDAY=SA </code> Note the start and end time's specific dates are largely arbitrary except to specify duration of the window and when it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. + */ + recurrence?: string | null; + /** + * The window of the first recurrence. + */ + window?: Schema$TimeWindow; + } + /** + * [ReservationAffinity](/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. + */ + export interface Schema$ReservationAffinity { + /** + * Corresponds to the type of reservation consumption. + */ + consumeReservationType?: string | null; + /** + * Corresponds to the label key of reservation resource. + */ + key?: string | null; + /** + * Corresponds to the label value(s) of reservation resource(s). + */ + values?: string[] | null; + } /** * Contains information about amount of some resource in the cluster. For memory, value should be in GB. */ @@ -1302,7 +1361,7 @@ export namespace container_v1 { */ export interface Schema$RollbackNodePoolUpgradeRequest { /** - * Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field. */ clusterId?: string | null; /** @@ -1310,15 +1369,15 @@ export namespace container_v1 { */ name?: string | null; /** - * Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field. */ nodePoolId?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -1352,11 +1411,11 @@ export namespace container_v1 { */ export interface Schema$SetAddonsConfigRequest { /** - * The desired configurations for the various addons available to run in the cluster. + * Required. The desired configurations for the various addons available to run in the cluster. */ addonsConfig?: Schema$AddonsConfig; /** - * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string | null; /** @@ -1364,11 +1423,11 @@ export namespace container_v1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -1377,11 +1436,11 @@ export namespace container_v1 { */ export interface Schema$SetLabelsRequest { /** - * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string | null; /** - * The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Kubernetes Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a <code>get()</code> request to the resource to get the latest fingerprint. + * Required. The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Kubernetes Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a <code>get()</code> request to the resource to get the latest fingerprint. */ labelFingerprint?: string | null; /** @@ -1389,15 +1448,15 @@ export namespace container_v1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * The labels to set for that cluster. + * Required. The labels to set for that cluster. */ resourceLabels?: {[key: string]: string} | null; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -1406,11 +1465,11 @@ export namespace container_v1 { */ export interface Schema$SetLegacyAbacRequest { /** - * Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. */ clusterId?: string | null; /** - * Whether ABAC authorization will be enabled in the cluster. + * Required. Whether ABAC authorization will be enabled in the cluster. */ enabled?: boolean | null; /** @@ -1418,11 +1477,11 @@ export namespace container_v1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -1431,11 +1490,11 @@ export namespace container_v1 { */ export interface Schema$SetLocationsRequest { /** - * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string | null; /** - * The desired list of Google Compute Engine [zones](/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone. + * Required. The desired list of Google Compute Engine [zones](/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone. */ locations?: string[] | null; /** @@ -1443,11 +1502,11 @@ export namespace container_v1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -1456,11 +1515,11 @@ export namespace container_v1 { */ export interface Schema$SetLoggingServiceRequest { /** - * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string | null; /** - * The logging service the cluster should use to write metrics. Currently available options: * "logging.googleapis.com" - the Google Cloud Logging service * "none" - no metrics will be exported from the cluster + * Required. The logging service the cluster should use to write metrics. Currently available options: * "logging.googleapis.com" - the Google Cloud Logging service * "none" - no metrics will be exported from the cluster */ loggingService?: string | null; /** @@ -1468,11 +1527,11 @@ export namespace container_v1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -1481,11 +1540,11 @@ export namespace container_v1 { */ export interface Schema$SetMaintenancePolicyRequest { /** - * The name of the cluster to update. + * Required. The name of the cluster to update. */ clusterId?: string | null; /** - * The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy. + * Required. The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy. */ maintenancePolicy?: Schema$MaintenancePolicy; /** @@ -1493,11 +1552,11 @@ export namespace container_v1 { */ name?: string | null; /** - * The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). + * Required. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). */ projectId?: string | null; /** - * The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. + * Required. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. */ zone?: string | null; } @@ -1506,11 +1565,11 @@ export namespace container_v1 { */ export interface Schema$SetMasterAuthRequest { /** - * The exact form of action to be taken on the master auth. + * Required. The exact form of action to be taken on the master auth. */ action?: string | null; /** - * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string | null; /** @@ -1518,15 +1577,15 @@ export namespace container_v1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * A description of the update. + * Required. A description of the update. */ update?: Schema$MasterAuth; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -1535,11 +1594,11 @@ export namespace container_v1 { */ export interface Schema$SetMonitoringServiceRequest { /** - * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string | null; /** - * The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com/kubernetes" - the Google Cloud Monitoring service with Kubernetes-native resource model * "monitoring.googleapis.com" - the Google Cloud Monitoring service * "none" - no metrics will be exported from the cluster + * Required. The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com/kubernetes" - the Google Cloud Monitoring service with Kubernetes-native resource model * "monitoring.googleapis.com" - the Google Cloud Monitoring service * "none" - no metrics will be exported from the cluster */ monitoringService?: string | null; /** @@ -1547,11 +1606,11 @@ export namespace container_v1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -1560,7 +1619,7 @@ export namespace container_v1 { */ export interface Schema$SetNetworkPolicyRequest { /** - * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string | null; /** @@ -1568,15 +1627,15 @@ export namespace container_v1 { */ name?: string | null; /** - * Configuration options for the NetworkPolicy feature. + * Required. Configuration options for the NetworkPolicy feature. */ networkPolicy?: Schema$NetworkPolicy; /** - * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -1585,11 +1644,11 @@ export namespace container_v1 { */ export interface Schema$SetNodePoolAutoscalingRequest { /** - * Autoscaling configuration for the node pool. + * Required. Autoscaling configuration for the node pool. */ autoscaling?: Schema$NodePoolAutoscaling; /** - * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string | null; /** @@ -1597,15 +1656,15 @@ export namespace container_v1 { */ name?: string | null; /** - * Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. */ nodePoolId?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -1614,11 +1673,11 @@ export namespace container_v1 { */ export interface Schema$SetNodePoolManagementRequest { /** - * Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. */ clusterId?: string | null; /** - * NodeManagement configuration for the node pool. + * Required. NodeManagement configuration for the node pool. */ management?: Schema$NodeManagement; /** @@ -1626,15 +1685,15 @@ export namespace container_v1 { */ name?: string | null; /** - * Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. */ nodePoolId?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -1643,7 +1702,7 @@ export namespace container_v1 { */ export interface Schema$SetNodePoolSizeRequest { /** - * Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. */ clusterId?: string | null; /** @@ -1651,19 +1710,19 @@ export namespace container_v1 { */ name?: string | null; /** - * The desired node count for the pool. + * Required. The desired node count for the pool. */ nodeCount?: number | null; /** - * Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. */ nodePoolId?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -1685,7 +1744,7 @@ export namespace container_v1 { */ export interface Schema$StartIPRotationRequest { /** - * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string | null; /** @@ -1693,7 +1752,7 @@ export namespace container_v1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** @@ -1701,7 +1760,7 @@ export namespace container_v1 { */ rotateCredentials?: boolean | null; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -1718,12 +1777,25 @@ export namespace container_v1 { */ message?: string | null; } + /** + * Represents an arbitrary window of time. + */ + export interface Schema$TimeWindow { + /** + * The time that the window ends. The end time should take place after the start time. + */ + endTime?: string | null; + /** + * The time that the window first starts. + */ + startTime?: string | null; + } /** * UpdateClusterRequest updates the settings of a cluster. */ export interface Schema$UpdateClusterRequest { /** - * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string | null; /** @@ -1731,15 +1803,15 @@ export namespace container_v1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * A description of the update. + * Required. A description of the update. */ update?: Schema$ClusterUpdate; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -1748,11 +1820,11 @@ export namespace container_v1 { */ export interface Schema$UpdateMasterRequest { /** - * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string | null; /** - * The Kubernetes version to change the master to. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the default Kubernetes version + * Required. The Kubernetes version to change the master to. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the default Kubernetes version */ masterVersion?: string | null; /** @@ -1760,11 +1832,11 @@ export namespace container_v1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -1773,11 +1845,11 @@ export namespace container_v1 { */ export interface Schema$UpdateNodePoolRequest { /** - * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string | null; /** - * The desired image type for the node pool. + * Required. The desired image type for the node pool. */ imageType?: string | null; /** @@ -1785,19 +1857,19 @@ export namespace container_v1 { */ name?: string | null; /** - * Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. */ nodePoolId?: string | null; /** - * The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the Kubernetes master version + * Required. The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the Kubernetes master version */ nodeVersion?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -2121,8 +2193,8 @@ export namespace container_v1 { * * @param {object} params Parameters for request * @param {string} params.name The name (project and location) of the server config to get, specified in the format 'projects/x/locations/x'. - * @param {string=} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string=} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. + * @param {string=} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string=} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2202,11 +2274,11 @@ export namespace container_v1 { */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -2531,10 +2603,10 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clusterId Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. + * @param {string=} params.clusterId Required. Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. * @param {string} params.name The name (project, location, cluster) of the cluster to delete. Specified in the format 'projects/x/locations/x/clusters/x'. - * @param {string=} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string=} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string=} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string=} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2652,10 +2724,10 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clusterId Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. + * @param {string=} params.clusterId Required. Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. * @param {string} params.name The name (project, location, cluster) of the cluster to retrieve. Specified in the format 'projects/x/locations/x/clusters/x'. - * @param {string=} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string=} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string=} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string=} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2895,8 +2967,8 @@ export namespace container_v1 { * * @param {object} params Parameters for request * @param {string} params.parent The parent (project and location) where the clusters will be listed. Specified in the format 'projects/x/locations/x'. Location "-" matches all zones and all regions. - * @param {string=} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. - * @param {string=} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. + * @param {string=} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. + * @param {string=} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4521,7 +4593,7 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** @@ -4529,11 +4601,11 @@ export namespace container_v1 { */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -4545,7 +4617,7 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** @@ -4553,11 +4625,11 @@ export namespace container_v1 { */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -4585,11 +4657,11 @@ export namespace container_v1 { */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. */ zone?: string; } @@ -4986,11 +5058,11 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clusterId Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * @param {string=} params.clusterId Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. * @param {string} params.name The name (project, location, cluster, node pool id) of the node pool to delete. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/x'. - * @param {string=} params.nodePoolId Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. - * @param {string=} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. - * @param {string=} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string=} params.nodePoolId Required. Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. + * @param {string=} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * @param {string=} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5109,11 +5181,11 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clusterId Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * @param {string=} params.clusterId Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. * @param {string} params.name The name (project, location, cluster, node pool id) of the node pool to get. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/x'. - * @param {string=} params.nodePoolId Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. - * @param {string=} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. - * @param {string=} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string=} params.nodePoolId Required. Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. + * @param {string=} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * @param {string=} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5229,10 +5301,10 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clusterId Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. + * @param {string=} params.clusterId Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. * @param {string} params.parent The parent (project, location, cluster id) where the node pools will be listed. Specified in the format 'projects/x/locations/x/clusters/x'. - * @param {string=} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field. - * @param {string=} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * @param {string=} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field. + * @param {string=} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5960,7 +6032,7 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** @@ -5968,15 +6040,15 @@ export namespace container_v1 { */ name?: string; /** - * Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -5988,7 +6060,7 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** @@ -5996,15 +6068,15 @@ export namespace container_v1 { */ name?: string; /** - * Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -6016,7 +6088,7 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. */ clusterId?: string; /** @@ -6024,11 +6096,11 @@ export namespace container_v1 { */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. */ zone?: string; } @@ -6441,9 +6513,9 @@ export namespace container_v1 { * * @param {object} params Parameters for request * @param {string} params.name The name (project, location, operation id) of the operation to get. Specified in the format 'projects/x/locations/x/operations/x'. - * @param {string=} params.operationId Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. - * @param {string=} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string=} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string=} params.operationId Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. + * @param {string=} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string=} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -6563,8 +6635,8 @@ export namespace container_v1 { * * @param {object} params Parameters for request * @param {string} params.parent The parent (project and location) where the operations will be listed. Specified in the format 'projects/x/locations/x'. Location "-" matches all zones and all regions. - * @param {string=} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. - * @param {string=} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. + * @param {string=} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. + * @param {string=} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -6663,15 +6735,15 @@ export namespace container_v1 { */ name?: string; /** - * Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. */ operationId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -6687,11 +6759,11 @@ export namespace container_v1 { */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. */ zone?: string; } @@ -6767,8 +6839,8 @@ export namespace container_v1 { * * @param {object} params Parameters for request * @param {string=} params.name The name (project and location) of the server config to get, specified in the format 'projects/x/locations/x'. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -6847,11 +6919,11 @@ export namespace container_v1 { */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -6935,9 +7007,9 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {().SetAddonsConfigRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -7074,9 +7146,9 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {().CompleteIPRotationRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -7209,8 +7281,8 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. * @param {().CreateClusterRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -7342,10 +7414,10 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. * @param {string=} params.name The name (project, location, cluster) of the cluster to delete. Specified in the format 'projects/x/locations/x/clusters/x'. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -7477,10 +7549,10 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. * @param {string=} params.name The name (project, location, cluster) of the cluster to retrieve. Specified in the format 'projects/x/locations/x/clusters/x'. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -7614,9 +7686,9 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {().SetLegacyAbacRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -7746,8 +7818,8 @@ export namespace container_v1 { * * @param {object} params Parameters for request * @param {string=} params.parent The parent (project and location) where the clusters will be listed. Specified in the format 'projects/x/locations/x'. Location "-" matches all zones and all regions. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -7884,9 +7956,9 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {().SetLocationsRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -8023,9 +8095,9 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {().SetLoggingServiceRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -8162,9 +8234,9 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {().UpdateMasterRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -8301,9 +8373,9 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {().SetMonitoringServiceRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -8440,9 +8512,9 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {().SetLabelsRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -8576,9 +8648,9 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId The name of the cluster to update. - * @param {string} params.projectId The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). - * @param {string} params.zone The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. + * @param {string} params.clusterId Required. The name of the cluster to update. + * @param {string} params.projectId Required. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). + * @param {string} params.zone Required. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. * @param {().SetMaintenancePolicyRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -8717,9 +8789,9 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {().SetMasterAuthRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -8856,9 +8928,9 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {().SetNetworkPolicyRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -8995,9 +9067,9 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {().StartIPRotationRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -9135,9 +9207,9 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {().UpdateClusterRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -9214,15 +9286,15 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -9239,15 +9311,15 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -9264,11 +9336,11 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. */ zone?: string; @@ -9285,7 +9357,7 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** @@ -9293,11 +9365,11 @@ export namespace container_v1 { */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -9309,7 +9381,7 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** @@ -9317,11 +9389,11 @@ export namespace container_v1 { */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -9333,15 +9405,15 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -9362,11 +9434,11 @@ export namespace container_v1 { */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. */ zone?: string; } @@ -9378,15 +9450,15 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -9403,15 +9475,15 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -9428,15 +9500,15 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -9453,15 +9525,15 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -9478,15 +9550,15 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -9503,15 +9575,15 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the cluster to update. + * Required. The name of the cluster to update. */ clusterId?: string; /** - * The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). + * Required. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). */ projectId?: string; /** - * The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. + * Required. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. */ zone?: string; @@ -9528,15 +9600,15 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -9553,15 +9625,15 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -9578,15 +9650,15 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -9603,15 +9675,15 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -9700,10 +9772,10 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. - * @param {string} params.nodePoolId Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * @param {string} params.nodePoolId Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {().SetNodePoolAutoscalingRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -9840,9 +9912,9 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. * @param {().CreateNodePoolRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -9979,11 +10051,11 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. * @param {string=} params.name The name (project, location, cluster, node pool id) of the node pool to delete. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/x'. - * @param {string} params.nodePoolId Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.nodePoolId Required. Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -10119,11 +10191,11 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. * @param {string=} params.name The name (project, location, cluster, node pool id) of the node pool to get. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/x'. - * @param {string} params.nodePoolId Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.nodePoolId Required. Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -10253,10 +10325,10 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. * @param {string=} params.parent The parent (project, location, cluster id) where the node pools will be listed. Specified in the format 'projects/x/locations/x/clusters/x'. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -10398,10 +10470,10 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field. - * @param {string} params.nodePoolId Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field. + * @param {string} params.nodePoolId Required. Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {().RollbackNodePoolUpgradeRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -10542,10 +10614,10 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. - * @param {string} params.nodePoolId Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. + * @param {string} params.nodePoolId Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {().SetNodePoolManagementRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -10686,10 +10758,10 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. - * @param {string} params.nodePoolId Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. + * @param {string} params.nodePoolId Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {().SetNodePoolSizeRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -10830,10 +10902,10 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. - * @param {string} params.nodePoolId Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * @param {string} params.nodePoolId Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {().UpdateNodePoolRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -10910,19 +10982,19 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -10939,15 +11011,15 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. */ zone?: string; @@ -10964,7 +11036,7 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** @@ -10972,15 +11044,15 @@ export namespace container_v1 { */ name?: string; /** - * Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -10992,7 +11064,7 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** @@ -11000,15 +11072,15 @@ export namespace container_v1 { */ name?: string; /** - * Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -11020,7 +11092,7 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. */ clusterId?: string; /** @@ -11028,11 +11100,11 @@ export namespace container_v1 { */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. */ zone?: string; } @@ -11044,19 +11116,19 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -11073,19 +11145,19 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -11102,19 +11174,19 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -11131,19 +11203,19 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -11224,9 +11296,9 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.operationId Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. + * @param {string} params.operationId Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. * @param {().CancelOperationRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -11358,9 +11430,9 @@ export namespace container_v1 { * * @param {object} params Parameters for request * @param {string=} params.name The name (project, location, operation id) of the operation to get. Specified in the format 'projects/x/locations/x/operations/x'. - * @param {string} params.operationId Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.operationId Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -11488,8 +11560,8 @@ export namespace container_v1 { * * @param {object} params Parameters for request * @param {string=} params.parent The parent (project and location) where the operations will be listed. Specified in the format 'projects/x/locations/x'. Location "-" matches all zones and all regions. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -11566,15 +11638,15 @@ export namespace container_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. */ operationId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -11595,15 +11667,15 @@ export namespace container_v1 { */ name?: string; /** - * Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. */ operationId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -11619,11 +11691,11 @@ export namespace container_v1 { */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. */ zone?: string; } diff --git a/src/apis/container/v1beta1.ts b/src/apis/container/v1beta1.ts index 932d48b8124..564dd960a81 100644 --- a/src/apis/container/v1beta1.ts +++ b/src/apis/container/v1beta1.ts @@ -136,6 +136,10 @@ export namespace container_v1beta1 { * Configuration for the Cloud Run addon. The `IstioConfig` addon must be enabled in order to enable Cloud Run addon. This option can only be enabled at cluster creation time. */ cloudRunConfig?: Schema$CloudRunConfig; + /** + * Configuration for NodeLocalDNS, a dns cache running on cluster nodes + */ + dnsCacheConfig?: Schema$DnsCacheConfig; /** * Configuration for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods. */ @@ -148,6 +152,10 @@ export namespace container_v1beta1 { * Configuration for Istio, an open platform to connect, manage, and secure microservices. */ istioConfig?: Schema$IstioConfig; + /** + * Configuration for the KALM addon, which manages the lifecycle of k8s applications. + */ + kalmConfig?: Schema$KalmConfig; /** * Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards */ @@ -204,6 +212,19 @@ export namespace container_v1beta1 { */ description?: string | null; } + /** + * AvailableVersion is an additional Kubernetes versions offered to users who subscribed to the release channel. + */ + export interface Schema$AvailableVersion { + /** + * Reason for availability. + */ + reason?: string | null; + /** + * Kubernetes version. + */ + version?: string | null; + } /** * Parameters for using BigQuery as the destination of resource usage export. */ @@ -231,15 +252,15 @@ export namespace container_v1beta1 { */ name?: string | null; /** - * Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. */ operationId?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -298,6 +319,10 @@ export namespace container_v1beta1 { * The IP address range of the container pods in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically chosen or specify a `/14` block in `10.0.0.0/8`. */ clusterIpv4Cidr?: string | null; + /** + * Telemetry integration for the cluster. + */ + clusterTelemetry?: Schema$ClusterTelemetry; /** * Which conditions caused the current cluster state. */ @@ -511,6 +536,10 @@ export namespace container_v1beta1 { * AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. */ autoprovisioningNodePoolDefaults?: Schema$AutoprovisioningNodePoolDefaults; + /** + * Defines autoscaling behaviour. + */ + autoscalingProfile?: string | null; /** * Enables automatic node pool creation and deletion. */ @@ -520,6 +549,15 @@ export namespace container_v1beta1 { */ resourceLimits?: Schema$ResourceLimit[]; } + /** + * Telemetry integration for the cluster. + */ + export interface Schema$ClusterTelemetry { + /** + * Type of the integration. + */ + type?: string | null; + } /** * ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided. */ @@ -536,6 +574,10 @@ export namespace container_v1beta1 { * Cluster-level autoscaling configuration. */ desiredClusterAutoscaling?: Schema$ClusterAutoscaling; + /** + * The desired telemetry integration for the cluster. + */ + desiredClusterTelemetry?: Schema$ClusterTelemetry; /** * Configuration of etcd encryption. */ @@ -588,6 +630,10 @@ export namespace container_v1beta1 { * The desired private cluster configuration. */ desiredPrivateClusterConfig?: Schema$PrivateClusterConfig; + /** + * The desired release channel configuration. + */ + desiredReleaseChannel?: Schema$ReleaseChannel; /** * The desired configuration for exporting resource usage. */ @@ -610,7 +656,7 @@ export namespace container_v1beta1 { */ export interface Schema$CompleteIPRotationRequest { /** - * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string | null; /** @@ -618,11 +664,11 @@ export namespace container_v1beta1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -640,7 +686,7 @@ export namespace container_v1beta1 { */ export interface Schema$CreateClusterRequest { /** - * A [cluster resource](/container-engine/reference/rest/v1beta1/projects.zones.clusters) + * Required. A [cluster resource](/container-engine/reference/rest/v1beta1/projects.zones.clusters) */ cluster?: Schema$Cluster; /** @@ -648,11 +694,11 @@ export namespace container_v1beta1 { */ parent?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. */ zone?: string | null; } @@ -661,11 +707,11 @@ export namespace container_v1beta1 { */ export interface Schema$CreateNodePoolRequest { /** - * Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. */ clusterId?: string | null; /** - * The node pool to create. + * Required. The node pool to create. */ nodePool?: Schema$NodePool; /** @@ -673,11 +719,11 @@ export namespace container_v1beta1 { */ parent?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. */ zone?: string | null; } @@ -707,6 +753,15 @@ export namespace container_v1beta1 { */ state?: string | null; } + /** + * Configuration for NodeLocal DNSCache + */ + export interface Schema$DnsCacheConfig { + /** + * Whether NodeLocal DNSCache is enabled for this cluster. + */ + enabled?: boolean | null; + } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ @@ -929,6 +984,15 @@ export namespace container_v1beta1 { */ y?: string | null; } + /** + * Configuration options for the KALM addon. + */ + export interface Schema$KalmConfig { + /** + * Whether KALM is enabled for this cluster. + */ + enabled?: boolean | null; + } /** * Configuration for the Kubernetes Dashboard. */ @@ -1196,11 +1260,11 @@ export namespace container_v1beta1 { */ machineType?: string | null; /** - * The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: "cluster-location" "cluster-name" "cluster-uid" "configure-sh" "containerd-configure-sh" "enable-oslogin" "gci-ensure-gke-docker" "gci-update-strategy" "instance-template" "kube-env" "startup-script" "user-data" "disable-address-manager" "windows-startup-script-ps1" "common-psm1" "k8s-node-setup-psm1" "install-ssh-psm1" "user-profile-psm1" "serial-port-logging-enable" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. + * The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: "cluster-location" "cluster-name" "cluster-uid" "configure-sh" "containerd-configure-sh" "enable-oslogin" "gci-ensure-gke-docker" "gci-metrics-enabled" "gci-update-strategy" "instance-template" "kube-env" "startup-script" "user-data" "disable-address-manager" "windows-startup-script-ps1" "common-psm1" "k8s-node-setup-psm1" "install-ssh-psm1" "user-profile-psm1" "serial-port-logging-enable" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. */ metadata?: {[key: string]: string} | null; /** - * Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) + * Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) To unset the min cpu platform field pass "automatic" as field value. */ minCpuPlatform?: string | null; /** @@ -1211,6 +1275,10 @@ export namespace container_v1beta1 { * Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more inforamtion about preemptible VM instances. */ preemptible?: boolean | null; + /** + * The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](/compute/docs/instances/reserving-zonal-resources) to this node pool. + */ + reservationAffinity?: Schema$ReservationAffinity; /** * Sandbox configuration for this node. */ @@ -1519,6 +1587,10 @@ export namespace container_v1beta1 { * ReleaseChannelConfig exposes configuration for a release channel. */ export interface Schema$ReleaseChannelConfig { + /** + * List of available versions for the release channel. + */ + availableVersions?: Schema$AvailableVersion[]; /** * The release channel this configuration applies to. */ @@ -1528,6 +1600,23 @@ export namespace container_v1beta1 { */ defaultVersion?: string | null; } + /** + * [ReservationAffinity](/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. + */ + export interface Schema$ReservationAffinity { + /** + * Corresponds to the type of reservation consumption. + */ + consumeReservationType?: string | null; + /** + * Corresponds to the label key of reservation resource. + */ + key?: string | null; + /** + * Corresponds to the label value(s) of reservation resource(s). + */ + values?: string[] | null; + } /** * Contains information about amount of some resource in the cluster. For memory, value should be in GB. */ @@ -1567,7 +1656,7 @@ export namespace container_v1beta1 { */ export interface Schema$RollbackNodePoolUpgradeRequest { /** - * Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field. */ clusterId?: string | null; /** @@ -1575,15 +1664,15 @@ export namespace container_v1beta1 { */ name?: string | null; /** - * Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field. */ nodePoolId?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -1634,11 +1723,11 @@ export namespace container_v1beta1 { */ export interface Schema$SetAddonsConfigRequest { /** - * The desired configurations for the various addons available to run in the cluster. + * Required. The desired configurations for the various addons available to run in the cluster. */ addonsConfig?: Schema$AddonsConfig; /** - * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string | null; /** @@ -1646,11 +1735,11 @@ export namespace container_v1beta1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -1659,11 +1748,11 @@ export namespace container_v1beta1 { */ export interface Schema$SetLabelsRequest { /** - * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string | null; /** - * The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Kubernetes Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a <code>get()</code> request to the resource to get the latest fingerprint. + * Required. The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Kubernetes Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a <code>get()</code> request to the resource to get the latest fingerprint. */ labelFingerprint?: string | null; /** @@ -1671,15 +1760,15 @@ export namespace container_v1beta1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * The labels to set for that cluster. + * Required. The labels to set for that cluster. */ resourceLabels?: {[key: string]: string} | null; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -1688,11 +1777,11 @@ export namespace container_v1beta1 { */ export interface Schema$SetLegacyAbacRequest { /** - * Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. */ clusterId?: string | null; /** - * Whether ABAC authorization will be enabled in the cluster. + * Required. Whether ABAC authorization will be enabled in the cluster. */ enabled?: boolean | null; /** @@ -1700,11 +1789,11 @@ export namespace container_v1beta1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -1713,11 +1802,11 @@ export namespace container_v1beta1 { */ export interface Schema$SetLocationsRequest { /** - * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string | null; /** - * The desired list of Google Compute Engine [zones](/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone. + * Required. The desired list of Google Compute Engine [zones](/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone. */ locations?: string[] | null; /** @@ -1725,11 +1814,11 @@ export namespace container_v1beta1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -1738,11 +1827,11 @@ export namespace container_v1beta1 { */ export interface Schema$SetLoggingServiceRequest { /** - * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string | null; /** - * The logging service the cluster should use to write metrics. Currently available options: * "logging.googleapis.com" - the Google Cloud Logging service * "none" - no metrics will be exported from the cluster + * Required. The logging service the cluster should use to write metrics. Currently available options: * "logging.googleapis.com" - the Google Cloud Logging service * "none" - no metrics will be exported from the cluster */ loggingService?: string | null; /** @@ -1750,11 +1839,11 @@ export namespace container_v1beta1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -1763,11 +1852,11 @@ export namespace container_v1beta1 { */ export interface Schema$SetMaintenancePolicyRequest { /** - * The name of the cluster to update. + * Required. The name of the cluster to update. */ clusterId?: string | null; /** - * The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy. + * Required. The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy. */ maintenancePolicy?: Schema$MaintenancePolicy; /** @@ -1775,11 +1864,11 @@ export namespace container_v1beta1 { */ name?: string | null; /** - * The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). + * Required. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). */ projectId?: string | null; /** - * The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. + * Required. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. */ zone?: string | null; } @@ -1788,11 +1877,11 @@ export namespace container_v1beta1 { */ export interface Schema$SetMasterAuthRequest { /** - * The exact form of action to be taken on the master auth. + * Required. The exact form of action to be taken on the master auth. */ action?: string | null; /** - * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string | null; /** @@ -1800,15 +1889,15 @@ export namespace container_v1beta1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * A description of the update. + * Required. A description of the update. */ update?: Schema$MasterAuth; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -1817,11 +1906,11 @@ export namespace container_v1beta1 { */ export interface Schema$SetMonitoringServiceRequest { /** - * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string | null; /** - * The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com" - the Google Cloud Monitoring service * "none" - no metrics will be exported from the cluster + * Required. The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com" - the Google Cloud Monitoring service * "none" - no metrics will be exported from the cluster */ monitoringService?: string | null; /** @@ -1829,11 +1918,11 @@ export namespace container_v1beta1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -1842,7 +1931,7 @@ export namespace container_v1beta1 { */ export interface Schema$SetNetworkPolicyRequest { /** - * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string | null; /** @@ -1850,15 +1939,15 @@ export namespace container_v1beta1 { */ name?: string | null; /** - * Configuration options for the NetworkPolicy feature. + * Required. Configuration options for the NetworkPolicy feature. */ networkPolicy?: Schema$NetworkPolicy; /** - * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -1867,11 +1956,11 @@ export namespace container_v1beta1 { */ export interface Schema$SetNodePoolAutoscalingRequest { /** - * Autoscaling configuration for the node pool. + * Required. Autoscaling configuration for the node pool. */ autoscaling?: Schema$NodePoolAutoscaling; /** - * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string | null; /** @@ -1879,15 +1968,15 @@ export namespace container_v1beta1 { */ name?: string | null; /** - * Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. */ nodePoolId?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -1896,11 +1985,11 @@ export namespace container_v1beta1 { */ export interface Schema$SetNodePoolManagementRequest { /** - * Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. */ clusterId?: string | null; /** - * NodeManagement configuration for the node pool. + * Required. NodeManagement configuration for the node pool. */ management?: Schema$NodeManagement; /** @@ -1908,15 +1997,15 @@ export namespace container_v1beta1 { */ name?: string | null; /** - * Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. */ nodePoolId?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -1925,7 +2014,7 @@ export namespace container_v1beta1 { */ export interface Schema$SetNodePoolSizeRequest { /** - * Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. */ clusterId?: string | null; /** @@ -1933,19 +2022,19 @@ export namespace container_v1beta1 { */ name?: string | null; /** - * The desired node count for the pool. + * Required. The desired node count for the pool. */ nodeCount?: number | null; /** - * Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. */ nodePoolId?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -1976,7 +2065,7 @@ export namespace container_v1beta1 { */ export interface Schema$StartIPRotationRequest { /** - * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string | null; /** @@ -1984,7 +2073,7 @@ export namespace container_v1beta1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** @@ -1992,7 +2081,7 @@ export namespace container_v1beta1 { */ rotateCredentials?: boolean | null; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -2049,7 +2138,7 @@ export namespace container_v1beta1 { */ export interface Schema$UpdateClusterRequest { /** - * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string | null; /** @@ -2057,15 +2146,15 @@ export namespace container_v1beta1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * A description of the update. + * Required. A description of the update. */ update?: Schema$ClusterUpdate; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -2074,11 +2163,11 @@ export namespace container_v1beta1 { */ export interface Schema$UpdateMasterRequest { /** - * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string | null; /** - * The Kubernetes version to change the master to. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the default Kubernetes version + * Required. The Kubernetes version to change the master to. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the default Kubernetes version */ masterVersion?: string | null; /** @@ -2086,11 +2175,11 @@ export namespace container_v1beta1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -2099,11 +2188,11 @@ export namespace container_v1beta1 { */ export interface Schema$UpdateNodePoolRequest { /** - * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string | null; /** - * The desired image type for the node pool. + * Required. The desired image type for the node pool. */ imageType?: string | null; /** @@ -2115,15 +2204,15 @@ export namespace container_v1beta1 { */ name?: string | null; /** - * Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. */ nodePoolId?: string | null; /** - * The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the Kubernetes master version + * Required. The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the Kubernetes master version */ nodeVersion?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** @@ -2135,7 +2224,7 @@ export namespace container_v1beta1 { */ workloadMetadataConfig?: Schema$WorkloadMetadataConfig; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -2262,7 +2351,7 @@ export namespace container_v1beta1 { * @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 {string} params.parent Required. 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 @@ -2358,7 +2447,7 @@ export namespace container_v1beta1 { */ pageToken?: string; /** - * The parent project where subnetworks are usable. Specified in the format 'projects/x'. + * Required. The parent project where subnetworks are usable. Specified in the format 'projects/x'. */ parent?: string; } @@ -2383,8 +2472,8 @@ export namespace container_v1beta1 { * * @param {object} params Parameters for request * @param {string} params.name The name (project and location) of the server config to get, specified in the format 'projects/x/locations/x'. - * @param {string=} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string=} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. + * @param {string=} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string=} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2458,7 +2547,7 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Contains the name of the resource requested. Specified in the format 'projects/x'. + * @param {string} params.parent Required. Contains the name of the resource requested. 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 @@ -2540,11 +2629,11 @@ export namespace container_v1beta1 { */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -2556,7 +2645,7 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Contains the name of the resource requested. Specified in the format 'projects/x'. + * Required. Contains the name of the resource requested. Specified in the format 'projects/x'. */ parent?: string; } @@ -2732,10 +2821,10 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clusterId Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. + * @param {string=} params.clusterId Required. Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. * @param {string} params.name The name (project, location, cluster) of the cluster to delete. Specified in the format 'projects/x/locations/x/clusters/x'. - * @param {string=} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string=} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string=} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string=} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2806,10 +2895,10 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clusterId Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. + * @param {string=} params.clusterId Required. Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. * @param {string} params.name The name (project, location, cluster) of the cluster to retrieve. Specified in the format 'projects/x/locations/x/clusters/x'. - * @param {string=} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string=} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string=} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string=} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2957,8 +3046,8 @@ export namespace container_v1beta1 { * * @param {object} params Parameters for request * @param {string} params.parent The parent (project and location) where the clusters will be listed. Specified in the format 'projects/x/locations/x'. Location "-" matches all zones and all regions. - * @param {string=} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. - * @param {string=} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. + * @param {string=} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. + * @param {string=} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3969,7 +4058,7 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** @@ -3977,11 +4066,11 @@ export namespace container_v1beta1 { */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -3993,7 +4082,7 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** @@ -4001,11 +4090,11 @@ export namespace container_v1beta1 { */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -4033,11 +4122,11 @@ export namespace container_v1beta1 { */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. */ zone?: string; } @@ -4334,11 +4423,11 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clusterId Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * @param {string=} params.clusterId Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. * @param {string} params.name The name (project, location, cluster, node pool id) of the node pool to delete. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/x'. - * @param {string=} params.nodePoolId Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. - * @param {string=} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. - * @param {string=} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string=} params.nodePoolId Required. Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. + * @param {string=} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * @param {string=} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4409,11 +4498,11 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clusterId Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * @param {string=} params.clusterId Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. * @param {string} params.name The name (project, location, cluster, node pool id) of the node pool to get. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/x'. - * @param {string=} params.nodePoolId Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. - * @param {string=} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. - * @param {string=} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string=} params.nodePoolId Required. Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. + * @param {string=} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * @param {string=} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4482,10 +4571,10 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clusterId Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. + * @param {string=} params.clusterId Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. * @param {string} params.parent The parent (project, location, cluster id) where the node pools will be listed. Specified in the format 'projects/x/locations/x/clusters/x'. - * @param {string=} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field. - * @param {string=} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * @param {string=} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field. + * @param {string=} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4952,7 +5041,7 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** @@ -4960,15 +5049,15 @@ export namespace container_v1beta1 { */ name?: string; /** - * Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -4980,7 +5069,7 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** @@ -4988,15 +5077,15 @@ export namespace container_v1beta1 { */ name?: string; /** - * Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -5008,7 +5097,7 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. */ clusterId?: string; /** @@ -5016,11 +5105,11 @@ export namespace container_v1beta1 { */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. */ zone?: string; } @@ -5294,9 +5383,9 @@ export namespace container_v1beta1 { * * @param {object} params Parameters for request * @param {string} params.name The name (project, location, operation id) of the operation to get. Specified in the format 'projects/x/locations/x/operations/x'. - * @param {string=} params.operationId Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. - * @param {string=} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string=} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string=} params.operationId Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. + * @param {string=} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string=} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5368,8 +5457,8 @@ export namespace container_v1beta1 { * * @param {object} params Parameters for request * @param {string} params.parent The parent (project and location) where the operations will be listed. Specified in the format 'projects/x/locations/x'. Location "-" matches all zones and all regions. - * @param {string=} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. - * @param {string=} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. + * @param {string=} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. + * @param {string=} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5468,15 +5557,15 @@ export namespace container_v1beta1 { */ name?: string; /** - * Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. */ operationId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -5492,11 +5581,11 @@ export namespace container_v1beta1 { */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. */ zone?: string; } @@ -5519,8 +5608,8 @@ export namespace container_v1beta1 { * * @param {object} params Parameters for request * @param {string=} params.name The name (project and location) of the server config to get, specified in the format 'projects/x/locations/x'. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5600,11 +5689,11 @@ export namespace container_v1beta1 { */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -5626,9 +5715,9 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {().SetAddonsConfigRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5703,9 +5792,9 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {().CompleteIPRotationRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5780,8 +5869,8 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. * @param {().CreateClusterRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5855,10 +5944,10 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. * @param {string=} params.name The name (project, location, cluster) of the cluster to delete. Specified in the format 'projects/x/locations/x/clusters/x'. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5932,10 +6021,10 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. * @param {string=} params.name The name (project, location, cluster) of the cluster to retrieve. Specified in the format 'projects/x/locations/x/clusters/x'. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -6007,9 +6096,9 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {().SetLegacyAbacRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6085,8 +6174,8 @@ export namespace container_v1beta1 { * * @param {object} params Parameters for request * @param {string=} params.parent The parent (project and location) where the clusters will be listed. Specified in the format 'projects/x/locations/x'. Location "-" matches all zones and all regions. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -6161,9 +6250,9 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {().SetLocationsRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6238,9 +6327,9 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {().SetLoggingServiceRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6315,9 +6404,9 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {().UpdateMasterRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6392,9 +6481,9 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {().SetMonitoringServiceRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6469,9 +6558,9 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {().SetLabelsRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6546,9 +6635,9 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId The name of the cluster to update. - * @param {string} params.projectId The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). - * @param {string} params.zone The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. + * @param {string} params.clusterId Required. The name of the cluster to update. + * @param {string} params.projectId Required. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). + * @param {string} params.zone Required. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. * @param {().SetMaintenancePolicyRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6625,9 +6714,9 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {().SetMasterAuthRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6702,9 +6791,9 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {().SetNetworkPolicyRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6779,9 +6868,9 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {().StartIPRotationRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6856,9 +6945,9 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {().UpdateClusterRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6935,15 +7024,15 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -6960,15 +7049,15 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -6985,11 +7074,11 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. */ zone?: string; @@ -7006,7 +7095,7 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** @@ -7014,11 +7103,11 @@ export namespace container_v1beta1 { */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -7030,7 +7119,7 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** @@ -7038,11 +7127,11 @@ export namespace container_v1beta1 { */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -7054,15 +7143,15 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -7083,11 +7172,11 @@ export namespace container_v1beta1 { */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. */ zone?: string; } @@ -7099,15 +7188,15 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -7124,15 +7213,15 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -7149,15 +7238,15 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -7174,15 +7263,15 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -7199,15 +7288,15 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -7224,15 +7313,15 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the cluster to update. + * Required. The name of the cluster to update. */ clusterId?: string; /** - * The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). + * Required. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). */ projectId?: string; /** - * The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. + * Required. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. */ zone?: string; @@ -7249,15 +7338,15 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -7274,15 +7363,15 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -7299,15 +7388,15 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -7324,15 +7413,15 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -7355,10 +7444,10 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. - * @param {string} params.nodePoolId Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * @param {string} params.nodePoolId Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {().SetNodePoolAutoscalingRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -7433,9 +7522,9 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. * @param {().CreateNodePoolRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -7510,11 +7599,11 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. * @param {string=} params.name The name (project, location, cluster, node pool id) of the node pool to delete. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/x'. - * @param {string} params.nodePoolId Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.nodePoolId Required. Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -7588,11 +7677,11 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. * @param {string=} params.name The name (project, location, cluster, node pool id) of the node pool to get. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/x'. - * @param {string} params.nodePoolId Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.nodePoolId Required. Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -7664,10 +7753,10 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. * @param {string=} params.parent The parent (project, location, cluster id) where the node pools will be listed. Specified in the format 'projects/x/locations/x/clusters/x'. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -7743,10 +7832,10 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field. - * @param {string} params.nodePoolId Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field. + * @param {string} params.nodePoolId Required. Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {().RollbackNodePoolUpgradeRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -7821,10 +7910,10 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. - * @param {string} params.nodePoolId Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. + * @param {string} params.nodePoolId Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {().SetNodePoolManagementRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -7899,10 +7988,10 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. - * @param {string} params.nodePoolId Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. + * @param {string} params.nodePoolId Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {().SetNodePoolSizeRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -7977,10 +8066,10 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. - * @param {string} params.nodePoolId Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.clusterId Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * @param {string} params.nodePoolId Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {().UpdateNodePoolRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -8057,19 +8146,19 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -8086,15 +8175,15 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. */ zone?: string; @@ -8111,7 +8200,7 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** @@ -8119,15 +8208,15 @@ export namespace container_v1beta1 { */ name?: string; /** - * Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -8139,7 +8228,7 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** @@ -8147,15 +8236,15 @@ export namespace container_v1beta1 { */ name?: string; /** - * Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -8167,7 +8256,7 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. */ clusterId?: string; /** @@ -8175,11 +8264,11 @@ export namespace container_v1beta1 { */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. */ zone?: string; } @@ -8191,19 +8280,19 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -8220,19 +8309,19 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -8249,19 +8338,19 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -8278,19 +8367,19 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. */ clusterId?: string; /** - * Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -8313,9 +8402,9 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.operationId Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. + * @param {string} params.operationId Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. * @param {().CancelOperationRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -8389,9 +8478,9 @@ export namespace container_v1beta1 { * * @param {object} params Parameters for request * @param {string=} params.name The name (project, location, operation id) of the operation to get. Specified in the format 'projects/x/locations/x/operations/x'. - * @param {string} params.operationId Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * @param {string} params.operationId Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -8466,8 +8555,8 @@ export namespace container_v1beta1 { * * @param {object} params Parameters for request * @param {string=} params.parent The parent (project and location) where the operations will be listed. Specified in the format 'projects/x/locations/x'. Location "-" matches all zones and all regions. - * @param {string} params.projectId Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. - * @param {string} params.zone Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. + * @param {string} params.projectId Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. + * @param {string} params.zone Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -8544,15 +8633,15 @@ export namespace container_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. */ operationId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -8573,15 +8662,15 @@ export namespace container_v1beta1 { */ name?: string; /** - * Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. */ operationId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -8597,11 +8686,11 @@ export namespace container_v1beta1 { */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. + * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. */ zone?: string; } diff --git a/src/apis/containeranalysis/v1alpha1.ts b/src/apis/containeranalysis/v1alpha1.ts index db08787071f..0ecff0cd199 100644 --- a/src/apis/containeranalysis/v1alpha1.ts +++ b/src/apis/containeranalysis/v1alpha1.ts @@ -181,7 +181,7 @@ export namespace containeranalysis_v1alpha1 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -1020,19 +1020,19 @@ export namespace containeranalysis_v1alpha1 { signature?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if the incoming policy version does not meet the requirements for modifying the stored policy. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a binding (conditional or unconditional) from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, version compliance checks against the stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } diff --git a/src/apis/containeranalysis/v1beta1.ts b/src/apis/containeranalysis/v1beta1.ts index 45fa0ee2656..dd4bea3406a 100644 --- a/src/apis/containeranalysis/v1beta1.ts +++ b/src/apis/containeranalysis/v1beta1.ts @@ -182,7 +182,7 @@ export namespace containeranalysis_v1beta1 { */ export interface Schema$BatchCreateNotesRequest { /** - * The notes to create. Max allowed length is 1000. + * Required. The notes to create. Max allowed length is 1000. */ notes?: {[key: string]: Schema$Note} | null; } @@ -200,7 +200,7 @@ export namespace containeranalysis_v1beta1 { */ export interface Schema$BatchCreateOccurrencesRequest { /** - * The occurrences to create. Max allowed length is 1000. + * Required. The occurrences to create. Max allowed length is 1000. */ occurrences?: Schema$Occurrence[]; } @@ -222,7 +222,7 @@ export namespace containeranalysis_v1beta1 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -1110,19 +1110,19 @@ export namespace containeranalysis_v1beta1 { signature?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if the incoming policy version does not meet the requirements for modifying the stored policy. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a binding (conditional or unconditional) from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, version compliance checks against the stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } @@ -1429,7 +1429,7 @@ export namespace containeranalysis_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The name of the project in the form of `projects/[PROJECT_ID]`, under which the notes are to be created. + * @param {string} params.parent Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the notes are to be created. * @param {().BatchCreateNotesRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1509,8 +1509,8 @@ export namespace containeranalysis_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.noteId The ID to use for this note. - * @param {string} params.parent The name of the project in the form of `projects/[PROJECT_ID]`, under which the note is to be created. + * @param {string=} params.noteId Required. The ID to use for this note. + * @param {string} params.parent Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the note is to be created. * @param {().Note} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1584,7 +1584,7 @@ export namespace containeranalysis_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. + * @param {string} params.name Required. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1654,7 +1654,7 @@ export namespace containeranalysis_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. + * @param {string} params.name Required. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1801,7 +1801,7 @@ export namespace containeranalysis_v1beta1 { * @param {string=} params.filter The filter expression. * @param {integer=} params.pageSize Number of notes to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20. * @param {string=} params.pageToken Token to provide to skip to a particular spot in the list. - * @param {string} params.parent The name of the project to list notes for in the form of `projects/[PROJECT_ID]`. + * @param {string} params.parent Required. The name of the project to list notes for in the form of `projects/[PROJECT_ID]`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1876,7 +1876,7 @@ export namespace containeranalysis_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. + * @param {string} params.name Required. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. * @param {string=} params.updateMask The fields to update. * @param {().Note} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2107,7 +2107,7 @@ export namespace containeranalysis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the project in the form of `projects/[PROJECT_ID]`, under which the notes are to be created. + * Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the notes are to be created. */ parent?: string; @@ -2124,11 +2124,11 @@ export namespace containeranalysis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID to use for this note. + * Required. The ID to use for this note. */ noteId?: string; /** - * The name of the project in the form of `projects/[PROJECT_ID]`, under which the note is to be created. + * Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the note is to be created. */ parent?: string; @@ -2145,7 +2145,7 @@ export namespace containeranalysis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. + * Required. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. */ name?: string; } @@ -2157,7 +2157,7 @@ export namespace containeranalysis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. + * Required. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. */ name?: string; } @@ -2198,7 +2198,7 @@ export namespace containeranalysis_v1beta1 { */ pageToken?: string; /** - * The name of the project to list notes for in the form of `projects/[PROJECT_ID]`. + * Required. The name of the project to list notes for in the form of `projects/[PROJECT_ID]`. */ parent?: string; } @@ -2210,7 +2210,7 @@ export namespace containeranalysis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. + * Required. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. */ name?: string; /** @@ -2272,7 +2272,7 @@ export namespace containeranalysis_v1beta1 { * * @param {object} params Parameters for request * @param {string=} params.filter The filter expression. - * @param {string} params.name The name of the note to list occurrences for in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. + * @param {string} params.name Required. The name of the note to list occurrences for in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. * @param {integer=} params.pageSize Number of occurrences to return in the list. * @param {string=} params.pageToken Token to provide to skip to a particular spot in the list. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2362,7 +2362,7 @@ export namespace containeranalysis_v1beta1 { */ filter?: string; /** - * The name of the note to list occurrences for in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. + * Required. The name of the note to list occurrences for in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. */ name?: string; /** @@ -2388,7 +2388,7 @@ export namespace containeranalysis_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The name of the project in the form of `projects/[PROJECT_ID]`, under which the occurrences are to be created. + * @param {string} params.parent Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the occurrences are to be created. * @param {().BatchCreateOccurrencesRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2472,7 +2472,7 @@ export namespace containeranalysis_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The name of the project in the form of `projects/[PROJECT_ID]`, under which the occurrence is to be created. + * @param {string} params.parent Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the occurrence is to be created. * @param {().Occurrence} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2548,7 +2548,7 @@ export namespace containeranalysis_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. + * @param {string} params.name Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2618,7 +2618,7 @@ export namespace containeranalysis_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. + * @param {string} params.name Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2764,7 +2764,7 @@ export namespace containeranalysis_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. + * @param {string} params.name Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2838,7 +2838,7 @@ export namespace containeranalysis_v1beta1 { * * @param {object} params Parameters for request * @param {string=} params.filter The filter expression. - * @param {string} params.parent The name of the project to get a vulnerability summary for in the form of `projects/[PROJECT_ID]`. + * @param {string} params.parent Required. The name of the project to get a vulnerability summary for in the form of `projects/[PROJECT_ID]`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2924,7 +2924,7 @@ export namespace containeranalysis_v1beta1 { * @param {string=} params.filter The filter expression. * @param {integer=} params.pageSize Number of occurrences to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20. * @param {string=} params.pageToken Token to provide to skip to a particular spot in the list. - * @param {string} params.parent The name of the project to list occurrences for in the form of `projects/[PROJECT_ID]`. + * @param {string} params.parent Required. The name of the project to list occurrences for in the form of `projects/[PROJECT_ID]`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3001,7 +3001,7 @@ export namespace containeranalysis_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. + * @param {string} params.name Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. * @param {string=} params.updateMask The fields to update. * @param {().Occurrence} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3234,7 +3234,7 @@ export namespace containeranalysis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the project in the form of `projects/[PROJECT_ID]`, under which the occurrences are to be created. + * Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the occurrences are to be created. */ parent?: string; @@ -3251,7 +3251,7 @@ export namespace containeranalysis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the project in the form of `projects/[PROJECT_ID]`, under which the occurrence is to be created. + * Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the occurrence is to be created. */ parent?: string; @@ -3268,7 +3268,7 @@ export namespace containeranalysis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. + * Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. */ name?: string; } @@ -3280,7 +3280,7 @@ export namespace containeranalysis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. + * Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. */ name?: string; } @@ -3309,7 +3309,7 @@ export namespace containeranalysis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. + * Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. */ name?: string; } @@ -3325,7 +3325,7 @@ export namespace containeranalysis_v1beta1 { */ filter?: string; /** - * The name of the project to get a vulnerability summary for in the form of `projects/[PROJECT_ID]`. + * Required. The name of the project to get a vulnerability summary for in the form of `projects/[PROJECT_ID]`. */ parent?: string; } @@ -3349,7 +3349,7 @@ export namespace containeranalysis_v1beta1 { */ pageToken?: string; /** - * The name of the project to list occurrences for in the form of `projects/[PROJECT_ID]`. + * Required. The name of the project to list occurrences for in the form of `projects/[PROJECT_ID]`. */ parent?: string; } @@ -3361,7 +3361,7 @@ export namespace containeranalysis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. + * Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. */ name?: string; /** @@ -3422,7 +3422,7 @@ export namespace containeranalysis_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the scan configuration in the form of `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`. + * @param {string} params.name Required. The name of the scan configuration in the form of `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3494,10 +3494,10 @@ export namespace containeranalysis_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter The filter expression. + * @param {string=} params.filter Required. The filter expression. * @param {integer=} params.pageSize The number of scan configs to return in the list. * @param {string=} params.pageToken Token to provide to skip to a particular spot in the list. - * @param {string} params.parent The name of the project to list scan configurations for in the form of `projects/[PROJECT_ID]`. + * @param {string} params.parent Required. The name of the project to list scan configurations for in the form of `projects/[PROJECT_ID]`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3574,7 +3574,7 @@ export namespace containeranalysis_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the scan configuration in the form of `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`. + * @param {string} params.name Required. The name of the scan configuration in the form of `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`. * @param {().ScanConfig} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3649,7 +3649,7 @@ export namespace containeranalysis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the scan configuration in the form of `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`. + * Required. The name of the scan configuration in the form of `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`. */ name?: string; } @@ -3661,7 +3661,7 @@ export namespace containeranalysis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The filter expression. + * Required. The filter expression. */ filter?: string; /** @@ -3673,7 +3673,7 @@ export namespace containeranalysis_v1beta1 { */ pageToken?: string; /** - * The name of the project to list scan configurations for in the form of `projects/[PROJECT_ID]`. + * Required. The name of the project to list scan configurations for in the form of `projects/[PROJECT_ID]`. */ parent?: string; } @@ -3685,7 +3685,7 @@ export namespace containeranalysis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the scan configuration in the form of `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`. + * Required. The name of the scan configuration in the form of `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`. */ name?: string; diff --git a/src/apis/content/v2.1.ts b/src/apis/content/v2.1.ts index 41295be404a..49fbb4c3aef 100644 --- a/src/apis/content/v2.1.ts +++ b/src/apis/content/v2.1.ts @@ -1790,7 +1790,7 @@ export namespace content_v2_1 { */ fullName?: string | null; /** - * Email address for receiving merchant issued value-added tax or invoice documentation of this order. + * Email address for the merchant to send value-added tax or invoice documentation of the order. This documentation is made available to the customer. */ invoiceReceivingEmail?: string | null; /** @@ -2568,7 +2568,7 @@ export namespace content_v2_1 { } export interface Schema$OrderShipment { /** - * The carrier handling the shipment. Acceptable values for US are: - "gsx" - "ups" - "usps" - "fedex" - "dhl" - "ecourier" - "cxt" - "google" - "ontrac" - "emsy" - "ont" - "deliv" - "dynamex" - "lasership" - "mpx" - "uds" - "efw" - "yunexpress" - "china post" - "china ems" - "singapore post" - "pos malaysia" - "postnl" - "ptt" - "eub" - "chukou1" Acceptable values for FR are: - "colissimo" - "chronopost" - "gls" - "dpd" - "bpost" - "colis prive" - "boxtal" - "geodis" - "tnt" - "la poste" - "ups" + * The carrier handling the shipment. For supported carriers, Google includes the carrier name and tracking URL in emails to customers. For select supported carriers, Google also automatically updates the shipment status based on the provided shipment ID. Note: You can also use unsupported carriers, but emails to customers will not include the carrier name or tracking URL, and there will be no automatic order status updates. Supported carriers for US are: - "ups" (United Parcel Service) automatic status updates - "usps" (United States Postal Service) automatic status updates - "fedex" (FedEx) automatic status updates - "dhl" (DHL eCommerce) automatic status updates (US only) - "ontrac" (OnTrac) automatic status updates - "dhl express" (DHL Express) - "deliv" (Deliv) - "dynamex" (TForce) - "lasership" (LaserShip) - "mpx" (Military Parcel Xpress) - "uds" (United Delivery Service) - "efw" (Estes Forwarding Worldwide) - "jd logistics" (JD Logistics) - "yunexpress" (YunExpress) - "china post" (China Post) - "china ems" (China Post Express Mail Service) - "singapore post" (Singapore Post) - "pos malaysia" (Pos Malaysia) - "postnl" (PostNL) - "ptt" (PTT Turkish Post) - "eub" (ePacket) - "chukou1" (Chukou1 Logistics) Supported carriers for FR are: - "la poste" (La Poste) automatic status updates - "colissimo" (Colissimo by La Poste) automatic status updates - "ups" (United Parcel Service) automatic status updates - "chronopost" (Chronopost by La Poste) - "gls" (General Logistics Systems France) - "dpd" (DPD Group by GeoPost) - "bpost" (Belgian Post Group) - "colis prive" (Colis Privé) - "boxtal" (Boxtal) - "geodis" (GEODIS) - "tnt" (TNT) */ carrier?: string | null; /** @@ -3344,7 +3344,7 @@ export namespace content_v2_1 { */ costOfGoodsSold?: Schema$Price; /** - * A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (e.g., { "name": "size type", "value": "regular" }). This is useful for submitting attributes not explicitly exposed by the API. + * A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (e.g., { "name": "size type", "value": "regular" }). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Shopping Actions. */ customAttributes?: Schema$CustomAttribute[]; /** diff --git a/src/apis/content/v2.ts b/src/apis/content/v2.ts index 4873b8d89c5..8acade05d09 100644 --- a/src/apis/content/v2.ts +++ b/src/apis/content/v2.ts @@ -2074,7 +2074,7 @@ export namespace content_v2 { */ fullName?: string | null; /** - * Email address for receiving merchant issued value-added tax or invoice documentation of this order. + * Email address for the merchant to send value-added tax or invoice documentation of the order. This documentation is made available to the customer. */ invoiceReceivingEmail?: string | null; /** @@ -3198,7 +3198,7 @@ export namespace content_v2 { } export interface Schema$OrderShipment { /** - * The carrier handling the shipment. Acceptable values for US are: - "gsx" - "ups" - "usps" - "fedex" - "dhl" - "ecourier" - "cxt" - "google" - "ontrac" - "emsy" - "ont" - "deliv" - "dynamex" - "lasership" - "mpx" - "uds" - "efw" - "yunexpress" - "china post" - "china ems" - "singapore post" - "pos malaysia" - "postnl" - "ptt" - "eub" - "chukou1" Acceptable values for FR are: - "colissimo" - "chronopost" - "gls" - "dpd" - "bpost" - "colis prive" - "boxtal" - "geodis" - "tnt" - "la poste" - "ups" + * The carrier handling the shipment. For supported carriers, Google includes the carrier name and tracking URL in emails to customers. For select supported carriers, Google also automatically updates the shipment status based on the provided shipment ID. Note: You can also use unsupported carriers, but emails to customers will not include the carrier name or tracking URL, and there will be no automatic order status updates. Supported carriers for US are: - "ups" (United Parcel Service) automatic status updates - "usps" (United States Postal Service) automatic status updates - "fedex" (FedEx) automatic status updates - "dhl" (DHL eCommerce) automatic status updates (US only) - "ontrac" (OnTrac) automatic status updates - "dhl express" (DHL Express) - "deliv" (Deliv) - "dynamex" (TForce) - "lasership" (LaserShip) - "mpx" (Military Parcel Xpress) - "uds" (United Delivery Service) - "efw" (Estes Forwarding Worldwide) - "jd logistics" (JD Logistics) - "yunexpress" (YunExpress) - "china post" (China Post) - "china ems" (China Post Express Mail Service) - "singapore post" (Singapore Post) - "pos malaysia" (Pos Malaysia) - "postnl" (PostNL) - "ptt" (PTT Turkish Post) - "eub" (ePacket) - "chukou1" (Chukou1 Logistics) Supported carriers for FR are: - "la poste" (La Poste) automatic status updates - "colissimo" (Colissimo by La Poste) automatic status updates - "ups" (United Parcel Service) automatic status updates - "chronopost" (Chronopost by La Poste) - "gls" (General Logistics Systems France) - "dpd" (DPD Group by GeoPost) - "bpost" (Belgian Post Group) - "colis prive" (Colis Privé) - "boxtal" (Boxtal) - "geodis" (GEODIS) - "tnt" (TNT) */ carrier?: string | null; /** @@ -4062,7 +4062,7 @@ export namespace content_v2 { */ costOfGoodsSold?: Schema$Price; /** - * A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (e.g., { "name": "size type", "value": "regular" }). This is useful for submitting attributes not explicitly exposed by the API. + * A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (e.g., { "name": "size type", "value": "regular" }). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Shopping Actions. */ customAttributes?: Schema$CustomAttribute[]; /** diff --git a/src/apis/datacatalog/v1beta1.ts b/src/apis/datacatalog/v1beta1.ts index 259db773623..62c81ae875b 100644 --- a/src/apis/datacatalog/v1beta1.ts +++ b/src/apis/datacatalog/v1beta1.ts @@ -128,7 +128,7 @@ export namespace datacatalog_v1beta1 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -432,7 +432,7 @@ export namespace datacatalog_v1beta1 { taxonomies?: Schema$GoogleCloudDatacatalogV1beta1Taxonomy[]; } /** - * Denotes one policy tag in a taxonomy (e.g. ssn). Policy Tags can be defined in a hierarchy. For example, consider the following hierachy: Geolocation | ------------------------------------ | | | LatLong City ZipCode PolicyTag "Geolocation" contains three child policy tags: "LatLong", "City", and "ZipCode". + * Denotes one policy tag in a taxonomy (e.g. ssn). Policy Tags can be defined in a hierarchy. For example, consider the following hierachy: Geolocation -&gt; (LatLong, City, ZipCode). PolicyTag "Geolocation" contains three child policy tags: "LatLong", "City", and "ZipCode". */ export interface Schema$GoogleCloudDatacatalogV1beta1PolicyTag { /** @@ -673,7 +673,7 @@ export namespace datacatalog_v1beta1 { displayName?: string | null; } /** - * A tag template defines the schema of the tags used to attach to Data Catalog resources. It defines the mapping of accepted field names and types that can be used within the tag. The tag template also controls the access to the tag. + * A tag template defines a tag, which can have one or more typed fields. The template is used to create and attach the tag to GCP resources. [Tag template roles](/iam/docs/understanding-roles#data-catalog-roles) provide permissions to create, edit, and use the template (see, for example, the [TagTemplate User](/data-catalog/docs/how-to/template-user) role, which includes permission to use the tag template to tag resources. */ export interface Schema$GoogleCloudDatacatalogV1beta1TagTemplate { /** @@ -699,6 +699,10 @@ export namespace datacatalog_v1beta1 { * The display name for this field. Defaults to an empty string. */ displayName?: string | null; + /** + * Whether this is a required field. Defaults to false. + */ + isRequired?: boolean | null; /** * Output only. The resource name of the tag template field in URL format. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template}/fields/{field} Note that this TagTemplateField may not actually be stored in the location in this name. */ @@ -739,19 +743,19 @@ export namespace datacatalog_v1beta1 { viewQuery?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if the incoming policy version does not meet the requirements for modifying the stored policy. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a binding (conditional or unconditional) from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, version compliance checks against the stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } @@ -1143,6 +1147,7 @@ export namespace datacatalog_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request + * @param {boolean=} params.force Optional. If true, deletes all entries in the entry group. * @param {string} params.name Required. The name of the entry group. For example, `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1551,6 +1556,10 @@ export namespace datacatalog_v1beta1 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * Optional. If true, deletes all entries in the entry group. + */ + force?: boolean; /** * Required. The name of the entry group. For example, `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`. */ @@ -3598,7 +3607,7 @@ export namespace datacatalog_v1beta1 { * * @param {object} params Parameters for request * @param {string} params.name Required. The name of the tag template field. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id} - * @param {string=} params.updateMask The field mask specifies the parts of the template to be updated. Allowed fields: * `display_name` * `type.enum_type` If `update_mask` is not set or empty, all of the allowed fields above will be updated. When updating an enum type, the provided values will be merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted nor renamed. + * @param {string=} params.updateMask Optional. The field mask specifies the parts of the template to be updated. Allowed fields: * `display_name` * `type.enum_type` * `is_required` If `update_mask` is not set or empty, all of the allowed fields above will be updated. When updating an enum type, the provided values will be merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted nor renamed. Updating a template field from optional to required is NOT allowed. * @param {().GoogleCloudDatacatalogV1beta1TagTemplateField} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3838,7 +3847,7 @@ export namespace datacatalog_v1beta1 { */ name?: string; /** - * The field mask specifies the parts of the template to be updated. Allowed fields: * `display_name` * `type.enum_type` If `update_mask` is not set or empty, all of the allowed fields above will be updated. When updating an enum type, the provided values will be merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted nor renamed. + * Optional. The field mask specifies the parts of the template to be updated. Allowed fields: * `display_name` * `type.enum_type` * `is_required` If `update_mask` is not set or empty, all of the allowed fields above will be updated. When updating an enum type, the provided values will be merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted nor renamed. Updating a template field from optional to required is NOT allowed. */ updateMask?: string; diff --git a/src/apis/dataflow/v1b3.ts b/src/apis/dataflow/v1b3.ts index 8656b9d8111..1e5d2e6a607 100644 --- a/src/apis/dataflow/v1b3.ts +++ b/src/apis/dataflow/v1b3.ts @@ -866,10 +866,18 @@ export namespace dataflow_v1b3 { * The template metadata describing the template name, available parameters, etc. */ metadata?: Schema$TemplateMetadata; + /** + * Describes the runtime metadata with SDKInfo and available parameters. + */ + runtimeMetadata?: Schema$RuntimeMetadata; /** * The status of the get template request. Any problems with the request will be indicated in the error_details. */ status?: Schema$Status; + /** + * Template Type. + */ + templateType?: string | null; } /** * Histogram of value counts for a distribution. Buckets have an inclusive lower bound and exclusive upper bound and use "1,2,5 bucketing": The first bucket range is from [0,1) and all subsequent bucket boundaries are powers of ten multiplied by 1, 2, or 5. Thus, bucket boundaries are 0, 1, 2, 5, 10, 20, 50, 100, 200, 500, 1000, ... Negative values are not supported. @@ -1538,6 +1546,10 @@ export namespace dataflow_v1b3 { * Required. The name of the parameter. */ name?: string | null; + /** + * Optional. The type of the parameter. Used for selecting input picker. + */ + paramType?: string | null; /** * Optional. Regexes that the parameter must match. */ @@ -1827,6 +1839,32 @@ export namespace dataflow_v1b3 { */ zone?: string | null; } + /** + * RuntimeMetadata describing a runtime environment. + */ + export interface Schema$RuntimeMetadata { + /** + * The parameters for the template. + */ + parameters?: Schema$ParameterMetadata[]; + /** + * SDK Info for the template. + */ + sdkInfo?: Schema$SDKInfo; + } + /** + * SDK Information. + */ + export interface Schema$SDKInfo { + /** + * Required. The SDK Language. + */ + language?: string | null; + /** + * Optional. The SDK version. + */ + version?: string | null; + } /** * The version of the SDK used to run the job. */ diff --git a/src/apis/dataproc/v1.ts b/src/apis/dataproc/v1.ts index 6ed1727b353..a6e51a48e82 100644 --- a/src/apis/dataproc/v1.ts +++ b/src/apis/dataproc/v1.ts @@ -124,7 +124,7 @@ export namespace dataproc_v1 { */ acceleratorCount?: number | null; /** - * Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples: https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80. + * Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples: https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80. */ acceleratorTypeUri?: string | null; } @@ -133,7 +133,7 @@ export namespace dataproc_v1 { */ export interface Schema$AutoscalingConfig { /** - * Optional. The autoscaling policy used by the cluster.Only resource names including projectid and location (region) are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id] projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note that the policy must be in the same project and Cloud Dataproc region. + * Optional. The autoscaling policy used by the cluster.Only resource names including projectid and location (region) are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id] projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note that the policy must be in the same project and Dataproc region. */ policyUri?: string | null; } @@ -206,7 +206,7 @@ export namespace dataproc_v1 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. + * Specifies the identities requesting access for a Cloud Platform resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. */ members?: string[] | null; /** @@ -227,11 +227,11 @@ export namespace dataproc_v1 { */ clusterName?: string | null; /** - * Output only. A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster. + * Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster. */ clusterUuid?: string | null; /** - * Required. The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated. + * Required. The cluster config. Note that Dataproc may set default values, and values may change when clusters are updated. */ config?: Schema$ClusterConfig; /** @@ -264,7 +264,7 @@ export namespace dataproc_v1 { */ autoscalingConfig?: Schema$AutoscalingConfig; /** - * Optional. A Google Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Cloud Dataproc staging bucket). + * Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging bucket). */ configBucket?: string | null; /** @@ -418,7 +418,7 @@ export namespace dataproc_v1 { */ state?: string | null; /** - * Output only. Time when this state was entered. + * Output only. Time when this state was entered (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)). */ stateStartTime?: string | null; /** @@ -507,7 +507,11 @@ export namespace dataproc_v1 { */ networkUri?: string | null; /** - * Optional. The service account of the instances. Defaults to the default Compute Engine service account. Custom service accounts need permissions equivalent to the following IAM roles: roles/logging.logWriter roles/storage.objectAdmin(see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information). Example: [account_id]@[project_id].iam.gserviceaccount.com + * Optional. Reservation Affinity for consuming Zonal reservation. + */ + reservationAffinity?: Schema$ReservationAffinity; + /** + * Optional. The Dataproc service account (also see VM Data Plane identity) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account is used. */ serviceAccount?: string | null; /** @@ -523,7 +527,7 @@ export namespace dataproc_v1 { */ tags?: string[] | null; /** - * Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the "global" region. If omitted in a non-global Cloud Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone] projects/[project_id]/zones/[zone] us-central1-f + * Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the "global" region. If omitted in a non-global Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone] projects/[project_id]/zones/[zone] us-central1-f */ zoneUri?: string | null; } @@ -546,7 +550,7 @@ export namespace dataproc_v1 { requestedPolicyVersion?: number | null; } /** - * A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). + * A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). */ export interface Schema$HadoopJob { /** @@ -578,12 +582,12 @@ export namespace dataproc_v1 { */ mainJarFileUri?: string | null; /** - * Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code. + * Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code. */ properties?: {[key: string]: string} | null; } /** - * A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. + * A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. */ export interface Schema$HiveJob { /** @@ -595,7 +599,7 @@ export namespace dataproc_v1 { */ jarFileUris?: string[] | null; /** - * Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code. + * Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code. */ properties?: {[key: string]: string} | null; /** @@ -645,7 +649,7 @@ export namespace dataproc_v1 { */ imageUri?: string | null; /** - * Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group. + * Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group. */ instanceNames?: string[] | null; /** @@ -653,7 +657,7 @@ export namespace dataproc_v1 { */ isPreemptible?: boolean | null; /** - * Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2 projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2 n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2. + * Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2 projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2 n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2. */ machineTypeUri?: string | null; /** @@ -661,7 +665,7 @@ export namespace dataproc_v1 { */ managedGroupConfig?: Schema$ManagedGroupConfig; /** - * Optional. Specifies the minimum cpu platform for the Instance Group. See Cloud Dataproc&rarr;Minimum CPU Platform. + * Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc&rarr;Minimum CPU Platform. */ minCpuPlatform?: string | null; /** @@ -687,7 +691,7 @@ export namespace dataproc_v1 { version?: number | null; } /** - * A Cloud Dataproc job resource. + * A Dataproc job resource. */ export interface Schema$Job { /** @@ -698,13 +702,7 @@ export namespace dataproc_v1 { * Output only. A URI pointing to the location of the stdout of the job's driver program. */ driverOutputResourceUri?: string | null; - /** - * Job is a Hadoop job. - */ hadoopJob?: Schema$HadoopJob; - /** - * Job is a Hive job. - */ hiveJob?: Schema$HiveJob; /** * Output only. A UUID that uniquely identifies a job within the project over time. This is in contrast to a user-settable reference.job_id that may be reused over time. @@ -714,17 +712,11 @@ export namespace dataproc_v1 { * Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job. */ labels?: {[key: string]: string} | null; - /** - * Job is a Pig job. - */ pigJob?: Schema$PigJob; /** * Required. Job information, including how, when, and where to run the job. */ placement?: Schema$JobPlacement; - /** - * Job is a Pyspark job. - */ pysparkJob?: Schema$PySparkJob; /** * Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>. @@ -734,17 +726,8 @@ export namespace dataproc_v1 { * Optional. Job scheduling configuration. */ scheduling?: Schema$JobScheduling; - /** - * Job is a Spark job. - */ sparkJob?: Schema$SparkJob; - /** - * Job is a SparkR job. - */ sparkRJob?: Schema$SparkRJob; - /** - * Job is a SparkSql job. - */ sparkSqlJob?: Schema$SparkSqlJob; /** * Output only. The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields. @@ -760,7 +743,7 @@ export namespace dataproc_v1 { yarnApplications?: Schema$YarnApplication[]; } /** - * Cloud Dataproc job config. + * Dataproc job config. */ export interface Schema$JobPlacement { /** @@ -768,7 +751,7 @@ export namespace dataproc_v1 { */ clusterName?: string | null; /** - * Output only. A cluster UUID generated by the Cloud Dataproc service when the job is submitted. + * Output only. A cluster UUID generated by the Dataproc service when the job is submitted. */ clusterUuid?: string | null; } @@ -795,7 +778,7 @@ export namespace dataproc_v1 { maxFailuresPerHour?: number | null; } /** - * Cloud Dataproc job status. + * Dataproc job status. */ export interface Schema$JobStatus { /** @@ -885,19 +868,19 @@ export namespace dataproc_v1 { */ export interface Schema$LifecycleConfig { /** - * Optional. The time when cluster will be auto-deleted. + * Optional. The time when cluster will be auto-deleted (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)). */ autoDeleteTime?: string | null; /** - * Optional. The lifetime duration of cluster. The cluster will be auto-deleted at the end of this period. Valid range: 10m, 14d.Example: "1d", to delete the cluster 1 day after its creation.. + * Optional. The lifetime duration of cluster. The cluster will be auto-deleted at the end of this period. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)). */ autoDeleteTtl?: string | null; /** - * Optional. The duration to keep the cluster alive while idling. Passing this threshold will cause the cluster to be deleted. Valid range: 10m, 14d.Example: "10m", the minimum value, to delete the cluster when it has had no jobs running for 10 minutes. + * Optional. The duration to keep the cluster alive while idling (when no jobs are running). Passing this threshold will cause the cluster to be deleted. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json). */ idleDeleteTtl?: string | null; /** - * Output only. The time when cluster became idle (most recent job finished) and became eligible for deletion due to idleness. + * Output only. The time when cluster became idle (most recent job finished) and became eligible for deletion due to idleness (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)). */ idleStartTime?: string | null; } @@ -1014,7 +997,7 @@ export namespace dataproc_v1 { */ executableFile?: string | null; /** - * Optional. Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period. + * Optional. Amount of time executable has to complete. Default is 10 minutes (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period. */ executionTimeout?: string | null; } @@ -1047,41 +1030,23 @@ export namespace dataproc_v1 { * A job executed by the workflow. */ export interface Schema$OrderedJob { - /** - * Job is a Hadoop job. - */ hadoopJob?: Schema$HadoopJob; - /** - * Job is a Hive job. - */ hiveJob?: Schema$HiveJob; /** * Optional. The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given job. */ labels?: {[key: string]: string} | null; - /** - * Job is a Pig job. - */ pigJob?: Schema$PigJob; /** * Optional. The optional list of prerequisite job step_ids. If not specified, the job will start at the beginning of workflow. */ prerequisiteStepIds?: string[] | null; - /** - * Job is a Pyspark job. - */ pysparkJob?: Schema$PySparkJob; /** * Optional. Job scheduling configuration. */ scheduling?: Schema$JobScheduling; - /** - * Job is a Spark job. - */ sparkJob?: Schema$SparkJob; - /** - * Job is a SparkSql job. - */ sparkSqlJob?: Schema$SparkSqlJob; /** * Required. The step id. The id must be unique among all jobs within the template.The step id is used as prefix for job id, as job goog-dataproc-workflow-step-id label, and in prerequisiteStepIds field from other steps.The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters. @@ -1102,7 +1067,7 @@ export namespace dataproc_v1 { values?: Schema$ValueValidation; } /** - * A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. + * A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. */ export interface Schema$PigJob { /** @@ -1118,7 +1083,7 @@ export namespace dataproc_v1 { */ loggingConfig?: Schema$LoggingConfig; /** - * Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code. + * Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code. */ properties?: {[key: string]: string} | null; /** @@ -1135,24 +1100,24 @@ export namespace dataproc_v1 { scriptVariables?: {[key: string]: string} | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource.JSON Example { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } YAML Example bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the IAM developer's guide (https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.Optionally, a binding can specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both.JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** - * Associates a list of members to a role. Optionally may specify a condition that determines when binding is in effect. bindings with no members will result in an error. + * Associates a list of members to a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one member. */ bindings?: Schema$Binding[]; /** - * etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.If no etag is provided in the call to setIamPolicy, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if either of incoming or stored policy does not meet the version requirements. + * etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a conditional binding from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset.If no etag is provided in the call to setIamPolicy, any version compliance checks on the incoming and/or stored policy is skipped. + * Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } /** - * A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. + * A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. */ export interface Schema$PySparkJob { /** @@ -1180,7 +1145,7 @@ export namespace dataproc_v1 { */ mainPythonFileUri?: string | null; /** - * Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. + * Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. */ properties?: {[key: string]: string} | null; /** @@ -1206,6 +1171,23 @@ export namespace dataproc_v1 { */ regexes?: string[] | null; } + /** + * Reservation Affinity for consuming Zonal reservation. + */ + export interface Schema$ReservationAffinity { + /** + * Optional. Type of reservation to consume + */ + consumeReservationType?: string | null; + /** + * Optional. Corresponds to the label key of reservation resource. + */ + key?: string | null; + /** + * Optional. Corresponds to the label values of reservation resource. + */ + values?: string[] | null; + } /** * Security related configuration, including Kerberos. */ @@ -1229,7 +1211,7 @@ export namespace dataproc_v1 { */ export interface Schema$SoftwareConfig { /** - * 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 Debian version. + * Optional. The version of software inside the cluster. It must be one of the supported 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 Debian version. */ imageVersion?: string | null; /** @@ -1242,7 +1224,7 @@ export namespace dataproc_v1 { properties?: {[key: string]: string} | null; } /** - * A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. + * A Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. */ export interface Schema$SparkJob { /** @@ -1274,12 +1256,12 @@ export namespace dataproc_v1 { */ mainJarFileUri?: string | null; /** - * Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. + * Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. */ properties?: {[key: string]: string} | null; } /** - * A Cloud Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. + * A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. */ export interface Schema$SparkRJob { /** @@ -1303,12 +1285,12 @@ export namespace dataproc_v1 { */ mainRFileUri?: string | null; /** - * Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. + * Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. */ properties?: {[key: string]: string} | null; } /** - * A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. + * A Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. */ export interface Schema$SparkSqlJob { /** @@ -1320,7 +1302,7 @@ export namespace dataproc_v1 { */ loggingConfig?: Schema$LoggingConfig; /** - * Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. + * Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten. */ properties?: {[key: string]: string} | null; /** @@ -1424,7 +1406,7 @@ export namespace dataproc_v1 { nodes?: Schema$WorkflowNode[]; } /** - * A Cloud Dataproc workflow template resource. + * A Dataproc workflow template resource. */ export interface Schema$WorkflowMetadata { /** @@ -1498,7 +1480,7 @@ export namespace dataproc_v1 { stepId?: string | null; } /** - * A Cloud Dataproc workflow template resource. + * A Dataproc workflow template resource. */ export interface Schema$WorkflowTemplate { /** @@ -4915,7 +4897,7 @@ export namespace dataproc_v1 { * * @param {object} params Parameters for request * @param {string} params.projectId Required. The ID of the Google Cloud Platform project that the cluster belongs to. - * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. + * @param {string} params.region Required. The Dataproc region in which to handle the request. * @param {string=} params.requestId Optional. A unique id used to identify the request. If the server receives two CreateClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. * @param {().Cluster} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5045,7 +5027,7 @@ export namespace dataproc_v1 { * @param {string} params.clusterName Required. The cluster name. * @param {string=} params.clusterUuid Optional. Specifying the cluster_uuid means the RPC should fail (with error NOT_FOUND) if cluster with specified UUID does not exist. * @param {string} params.projectId Required. The ID of the Google Cloud Platform project that the cluster belongs to. - * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. + * @param {string} params.region Required. The Dataproc region in which to handle the request. * @param {string=} params.requestId Optional. A unique id used to identify the request. If the server receives two DeleteClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5178,7 +5160,7 @@ export namespace dataproc_v1 { * @param {object} params Parameters for request * @param {string} params.clusterName Required. The cluster name. * @param {string} params.projectId Required. The ID of the Google Cloud Platform project that the cluster belongs to. - * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. + * @param {string} params.region Required. The Dataproc region in which to handle the request. * @param {().DiagnoseClusterRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5307,7 +5289,7 @@ export namespace dataproc_v1 { * @param {object} params Parameters for request * @param {string} params.clusterName Required. The cluster name. * @param {string} params.projectId Required. The ID of the Google Cloud Platform project that the cluster belongs to. - * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. + * @param {string} params.region Required. The Dataproc region in which to handle the request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5569,7 +5551,7 @@ export namespace dataproc_v1 { * @param {integer=} params.pageSize Optional. The standard List page size. * @param {string=} params.pageToken Optional. The standard List page token. * @param {string} params.projectId Required. The ID of the Google Cloud Platform project that the cluster belongs to. - * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. + * @param {string} params.region Required. The Dataproc region in which to handle the request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5702,9 +5684,9 @@ export namespace dataproc_v1 { * * @param {object} params Parameters for request * @param {string} params.clusterName Required. The cluster name. - * @param {string=} params.gracefulDecommissionTimeout Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day.Only supported on Dataproc image versions 1.2 and higher. + * @param {string=} params.gracefulDecommissionTimeout Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day. (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Only supported on Dataproc image versions 1.2 and higher. * @param {string} params.projectId Required. The ID of the Google Cloud Platform project the cluster belongs to. - * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. + * @param {string} params.region Required. The Dataproc region in which to handle the request. * @param {string=} params.requestId Optional. A unique id used to identify the request. If the server receives two UpdateClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. * @param {string=} params.updateMask Required. Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as config.worker_config.num_instances, and the PATCH request body would specify the new value, as follows: { "config":{ "workerConfig":{ "numInstances":"5" } } } Similarly, to change the number of preemptible workers in a cluster to 5, the update_mask parameter would be config.secondary_worker_config.num_instances, and the PATCH request body would be set as follows: { "config":{ "secondaryWorkerConfig":{ "numInstances":"5" } } } Note: Currently, only the following fields can be updated:
Mask Purpose
labels Update labels
config.worker_config.num_instances Resize primary worker group
config.secondary_worker_config.num_instances Resize secondary worker group
config.autoscaling_config.policy_uriUse, stop using, or change autoscaling policies
* @param {().Cluster} params.requestBody Request body data @@ -6044,7 +6026,7 @@ export namespace dataproc_v1 { */ projectId?: string; /** - * Required. The Cloud Dataproc region in which to handle the request. + * Required. The Dataproc region in which to handle the request. */ region?: string; /** @@ -6077,7 +6059,7 @@ export namespace dataproc_v1 { */ projectId?: string; /** - * Required. The Cloud Dataproc region in which to handle the request. + * Required. The Dataproc region in which to handle the request. */ region?: string; /** @@ -6101,7 +6083,7 @@ export namespace dataproc_v1 { */ projectId?: string; /** - * Required. The Cloud Dataproc region in which to handle the request. + * Required. The Dataproc region in which to handle the request. */ region?: string; @@ -6126,7 +6108,7 @@ export namespace dataproc_v1 { */ projectId?: string; /** - * Required. The Cloud Dataproc region in which to handle the request. + * Required. The Dataproc region in which to handle the request. */ region?: string; } @@ -6171,7 +6153,7 @@ export namespace dataproc_v1 { */ projectId?: string; /** - * Required. The Cloud Dataproc region in which to handle the request. + * Required. The Dataproc region in which to handle the request. */ region?: string; } @@ -6187,7 +6169,7 @@ export namespace dataproc_v1 { */ clusterName?: string; /** - * Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day.Only supported on Dataproc image versions 1.2 and higher. + * Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day. (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Only supported on Dataproc image versions 1.2 and higher. */ gracefulDecommissionTimeout?: string; /** @@ -6195,7 +6177,7 @@ export namespace dataproc_v1 { */ projectId?: string; /** - * Required. The Cloud Dataproc region in which to handle the request. + * Required. The Dataproc region in which to handle the request. */ region?: string; /** @@ -6318,7 +6300,7 @@ export namespace dataproc_v1 { * @param {object} params Parameters for request * @param {string} params.jobId Required. The job ID. * @param {string} params.projectId Required. The ID of the Google Cloud Platform project that the job belongs to. - * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. + * @param {string} params.region Required. The Dataproc region in which to handle the request. * @param {().CancelJobRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6442,7 +6424,7 @@ export namespace dataproc_v1 { * @param {object} params Parameters for request * @param {string} params.jobId Required. The job ID. * @param {string} params.projectId Required. The ID of the Google Cloud Platform project that the job belongs to. - * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. + * @param {string} params.region Required. The Dataproc region in which to handle the request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -6567,7 +6549,7 @@ export namespace dataproc_v1 { * @param {object} params Parameters for request * @param {string} params.jobId Required. The job ID. * @param {string} params.projectId Required. The ID of the Google Cloud Platform project that the job belongs to. - * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. + * @param {string} params.region Required. The Dataproc region in which to handle the request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -6830,7 +6812,7 @@ export namespace dataproc_v1 { * @param {integer=} params.pageSize Optional. The number of results to return in each response. * @param {string=} params.pageToken Optional. The page token, returned by a previous call, to request the next page of results. * @param {string} params.projectId Required. The ID of the Google Cloud Platform project that the job belongs to. - * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. + * @param {string} params.region Required. The Dataproc region in which to handle the request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -6962,7 +6944,7 @@ export namespace dataproc_v1 { * @param {object} params Parameters for request * @param {string} params.jobId Required. The job ID. * @param {string} params.projectId Required. The ID of the Google Cloud Platform project that the job belongs to. - * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. + * @param {string} params.region Required. The Dataproc region in which to handle the request. * @param {string=} params.updateMask Required. Specifies the path, relative to Job, of the field to update. For example, to update the labels of a Job the update_mask parameter would be specified as labels, and the PATCH request body would specify the new value. Note: Currently, labels is the only field that can be updated. * @param {().Job} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7213,7 +7195,7 @@ export namespace dataproc_v1 { * * @param {object} params Parameters for request * @param {string} params.projectId Required. The ID of the Google Cloud Platform project that the job belongs to. - * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. + * @param {string} params.region Required. The Dataproc region in which to handle the request. * @param {().SubmitJobRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -7428,7 +7410,7 @@ export namespace dataproc_v1 { */ projectId?: string; /** - * Required. The Cloud Dataproc region in which to handle the request. + * Required. The Dataproc region in which to handle the request. */ region?: string; @@ -7453,7 +7435,7 @@ export namespace dataproc_v1 { */ projectId?: string; /** - * Required. The Cloud Dataproc region in which to handle the request. + * Required. The Dataproc region in which to handle the request. */ region?: string; } @@ -7473,7 +7455,7 @@ export namespace dataproc_v1 { */ projectId?: string; /** - * Required. The Cloud Dataproc region in which to handle the request. + * Required. The Dataproc region in which to handle the request. */ region?: string; } @@ -7526,7 +7508,7 @@ export namespace dataproc_v1 { */ projectId?: string; /** - * Required. The Cloud Dataproc region in which to handle the request. + * Required. The Dataproc region in which to handle the request. */ region?: string; } @@ -7546,7 +7528,7 @@ export namespace dataproc_v1 { */ projectId?: string; /** - * Required. The Cloud Dataproc region in which to handle the request. + * Required. The Dataproc region in which to handle the request. */ region?: string; /** @@ -7588,7 +7570,7 @@ export namespace dataproc_v1 { */ projectId?: string; /** - * Required. The Cloud Dataproc region in which to handle the request. + * Required. The Dataproc region in which to handle the request. */ region?: string; diff --git a/src/apis/dataproc/v1beta2.ts b/src/apis/dataproc/v1beta2.ts index f85263f1a30..99770f0b6d9 100644 --- a/src/apis/dataproc/v1beta2.ts +++ b/src/apis/dataproc/v1beta2.ts @@ -124,7 +124,7 @@ export namespace dataproc_v1beta2 { */ acceleratorCount?: number | null; /** - * Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypesExamples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80. + * Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypesExamples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80. */ acceleratorTypeUri?: string | null; } @@ -133,7 +133,7 @@ export namespace dataproc_v1beta2 { */ export interface Schema$AutoscalingConfig { /** - * Optional. The autoscaling policy used by the cluster.Only resource names including projectid and location (region) are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id] projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note that the policy must be in the same project and Cloud Dataproc region. + * Optional. The autoscaling policy used by the cluster.Only resource names including projectid and location (region) are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id] projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note that the policy must be in the same project and Dataproc region. */ policyUri?: string | null; } @@ -206,7 +206,7 @@ export namespace dataproc_v1beta2 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. + * Specifies the identities requesting access for a Cloud Platform resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. */ members?: string[] | null; /** @@ -227,11 +227,11 @@ export namespace dataproc_v1beta2 { */ clusterName?: string | null; /** - * Output only. A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster. + * Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster. */ clusterUuid?: string | null; /** - * Required. The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated. + * Required. The cluster config. Note that Dataproc may set default values, and values may change when clusters are updated. */ config?: Schema$ClusterConfig; /** @@ -264,7 +264,7 @@ export namespace dataproc_v1beta2 { */ autoscalingConfig?: Schema$AutoscalingConfig; /** - * Optional. A Google Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Cloud Dataproc staging bucket). + * Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging bucket). */ configBucket?: string | null; /** @@ -422,7 +422,7 @@ export namespace dataproc_v1beta2 { */ state?: string | null; /** - * Output only. Time when this state was entered. + * Output only. Time when this state was entered (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)). */ stateStartTime?: string | null; /** @@ -528,7 +528,7 @@ export namespace dataproc_v1beta2 { */ reservationAffinity?: Schema$ReservationAffinity; /** - * Optional. The service account of the instances. Defaults to the default Compute Engine service account. Custom service accounts need permissions equivalent to the following IAM roles: roles/logging.logWriter roles/storage.objectAdmin(see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information). Example: [account_id]@[project_id].iam.gserviceaccount.com + * Optional. The Dataproc service account (also see VM Data Plane identity) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account is used. */ serviceAccount?: string | null; /** @@ -544,7 +544,7 @@ export namespace dataproc_v1beta2 { */ tags?: string[] | null; /** - * Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the "global" region. If omitted in a non-global Cloud Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone] projects/[project_id]/zones/[zone] us-central1-f + * Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the "global" region. If omitted in a non-global Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone] projects/[project_id]/zones/[zone] us-central1-f */ zoneUri?: string | null; } @@ -567,7 +567,7 @@ export namespace dataproc_v1beta2 { requestedPolicyVersion?: number | null; } /** - * A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). + * A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). */ export interface Schema$HadoopJob { /** @@ -599,12 +599,12 @@ export namespace dataproc_v1beta2 { */ mainJarFileUri?: string | null; /** - * Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code. + * Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code. */ properties?: {[key: string]: string} | null; } /** - * A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. + * A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. */ export interface Schema$HiveJob { /** @@ -616,7 +616,7 @@ export namespace dataproc_v1beta2 { */ jarFileUris?: string[] | null; /** - * Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code. + * Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code. */ properties?: {[key: string]: string} | null; /** @@ -666,7 +666,7 @@ export namespace dataproc_v1beta2 { */ imageUri?: string | null; /** - * Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group. + * Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group. */ instanceNames?: string[] | null; /** @@ -674,7 +674,7 @@ export namespace dataproc_v1beta2 { */ isPreemptible?: boolean | null; /** - * Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2 projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2 n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2. + * Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2 projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2 n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2. */ machineTypeUri?: string | null; /** @@ -682,7 +682,7 @@ export namespace dataproc_v1beta2 { */ managedGroupConfig?: Schema$ManagedGroupConfig; /** - * Specifies the minimum cpu platform for the Instance Group. See Cloud Dataproc&rarr;Minimum CPU Platform. + * Specifies the minimum cpu platform for the Instance Group. See Dataproc&rarr;Minimum CPU Platform. */ minCpuPlatform?: string | null; /** @@ -712,7 +712,7 @@ export namespace dataproc_v1beta2 { version?: number | null; } /** - * A Cloud Dataproc job resource. + * A Dataproc job resource. */ export interface Schema$Job { /** @@ -723,13 +723,7 @@ export namespace dataproc_v1beta2 { * Output only. A URI pointing to the location of the stdout of the job's driver program. */ driverOutputResourceUri?: string | null; - /** - * Job is a Hadoop job. - */ hadoopJob?: Schema$HadoopJob; - /** - * Job is a Hive job. - */ hiveJob?: Schema$HiveJob; /** * Output only. A UUID that uniquely identifies a job within the project over time. This is in contrast to a user-settable reference.job_id that may be reused over time. @@ -739,21 +733,12 @@ export namespace dataproc_v1beta2 { * Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job. */ labels?: {[key: string]: string} | null; - /** - * Job is a Pig job. - */ pigJob?: Schema$PigJob; /** * Required. Job information, including how, when, and where to run the job. */ placement?: Schema$JobPlacement; - /** - * Job is a Presto job - */ prestoJob?: Schema$PrestoJob; - /** - * Job is a Pyspark job. - */ pysparkJob?: Schema$PySparkJob; /** * Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>. @@ -763,17 +748,8 @@ export namespace dataproc_v1beta2 { * Optional. Job scheduling configuration. */ scheduling?: Schema$JobScheduling; - /** - * Job is a Spark job. - */ sparkJob?: Schema$SparkJob; - /** - * Job is a SparkR job. - */ sparkRJob?: Schema$SparkRJob; - /** - * Job is a SparkSql job. - */ sparkSqlJob?: Schema$SparkSqlJob; /** * Output only. The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields. @@ -793,7 +769,7 @@ export namespace dataproc_v1beta2 { yarnApplications?: Schema$YarnApplication[]; } /** - * Cloud Dataproc job config. + * Dataproc job config. */ export interface Schema$JobPlacement { /** @@ -801,7 +777,7 @@ export namespace dataproc_v1beta2 { */ clusterName?: string | null; /** - * Output only. A cluster UUID generated by the Cloud Dataproc service when the job is submitted. + * Output only. A cluster UUID generated by the Dataproc service when the job is submitted. */ clusterUuid?: string | null; } @@ -810,7 +786,7 @@ export namespace dataproc_v1beta2 { */ export interface Schema$JobReference { /** - * Optional. The job ID, which must be unique within the project.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.If not specified by the caller, the job ID will be provided by the server. + * Optional. The job ID, which must be unique within the project. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.If not specified by the caller, the job ID will be provided by the server. */ jobId?: string | null; /** @@ -828,11 +804,11 @@ export namespace dataproc_v1beta2 { maxFailuresPerHour?: number | null; } /** - * Cloud Dataproc job status. + * Dataproc job status. */ export interface Schema$JobStatus { /** - * Output only. Optional job state details, such as an error description if the state is <code>ERROR</code>. + * Output only. Optional Job state details, such as an error description if the state is <code>ERROR</code>. */ details?: string | null; /** @@ -918,19 +894,19 @@ export namespace dataproc_v1beta2 { */ export interface Schema$LifecycleConfig { /** - * Optional. The time when cluster will be auto-deleted. + * Optional. The time when cluster will be auto-deleted. (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)). */ autoDeleteTime?: string | null; /** - * Optional. The lifetime duration of cluster. The cluster will be auto-deleted at the end of this period. Valid range: 10m, 14d.Example: "1d", to delete the cluster 1 day after its creation.. + * Optional. The lifetime duration of cluster. The cluster will be auto-deleted at the end of this period. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)). */ autoDeleteTtl?: string | null; /** - * Optional. The duration to keep the cluster alive while idling. Passing this threshold will cause the cluster to be deleted. Valid range: 10m, 14d.Example: "10m", the minimum value, to delete the cluster when it has had no jobs running for 10 minutes. + * Optional. The duration to keep the cluster alive while idling (when no jobs are running). Passing this threshold will cause the cluster to be deleted. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json). */ idleDeleteTtl?: string | null; /** - * Output only. The time when cluster became idle (most recent job finished) and became eligible for deletion due to idleness. + * Output only. The time when cluster became idle (most recent job finished) and became eligible for deletion due to idleness (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)). */ idleStartTime?: string | null; } @@ -1047,7 +1023,7 @@ export namespace dataproc_v1beta2 { */ executableFile?: string | null; /** - * Optional. Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period. + * Optional. Amount of time executable has to complete. Default is 10 minutes (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period. */ executionTimeout?: string | null; } @@ -1080,41 +1056,23 @@ export namespace dataproc_v1beta2 { * A job executed by the workflow. */ export interface Schema$OrderedJob { - /** - * Job is a Hadoop job. - */ hadoopJob?: Schema$HadoopJob; - /** - * Job is a Hive job. - */ hiveJob?: Schema$HiveJob; /** * Optional. The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given job. */ labels?: {[key: string]: string} | null; - /** - * Job is a Pig job. - */ pigJob?: Schema$PigJob; /** * Optional. The optional list of prerequisite job step_ids. If not specified, the job will start at the beginning of workflow. */ prerequisiteStepIds?: string[] | null; - /** - * Job is a Pyspark job. - */ pysparkJob?: Schema$PySparkJob; /** * Optional. Job scheduling configuration. */ scheduling?: Schema$JobScheduling; - /** - * Job is a Spark job. - */ sparkJob?: Schema$SparkJob; - /** - * Job is a SparkSql job. - */ sparkSqlJob?: Schema$SparkSqlJob; /** * Required. The step id. The id must be unique among all jobs within the template.The step id is used as prefix for job id, as job goog-dataproc-workflow-step-id label, and in prerequisiteStepIds field from other steps.The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters. @@ -1135,7 +1093,7 @@ export namespace dataproc_v1beta2 { values?: Schema$ValueValidation; } /** - * A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. + * A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. */ export interface Schema$PigJob { /** @@ -1151,7 +1109,7 @@ export namespace dataproc_v1beta2 { */ loggingConfig?: Schema$LoggingConfig; /** - * Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code. + * Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code. */ properties?: {[key: string]: string} | null; /** @@ -1168,24 +1126,24 @@ export namespace dataproc_v1beta2 { scriptVariables?: {[key: string]: string} | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource.JSON Example { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } YAML Example bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the IAM developer's guide (https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.Optionally, a binding can specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both.JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** - * Associates a list of members to a role. Optionally may specify a condition that determines when binding is in effect. bindings with no members will result in an error. + * Associates a list of members to a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one member. */ bindings?: Schema$Binding[]; /** - * etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.If no etag is provided in the call to setIamPolicy, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if either of incoming or stored policy does not meet the version requirements. + * etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a conditional binding from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset.If no etag is provided in the call to setIamPolicy, any version compliance checks on the incoming and/or stored policy is skipped. + * Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } /** - * A Cloud Dataproc job for running Presto (https://prestosql.io/) queries + * A Dataproc job for running Presto (https://prestosql.io/) queries */ export interface Schema$PrestoJob { /** @@ -1218,7 +1176,7 @@ export namespace dataproc_v1beta2 { queryList?: Schema$QueryList; } /** - * A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. + * A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. */ export interface Schema$PySparkJob { /** @@ -1246,7 +1204,7 @@ export namespace dataproc_v1beta2 { */ mainPythonFileUri?: string | null; /** - * Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. + * Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. */ properties?: {[key: string]: string} | null; /** @@ -1312,7 +1270,7 @@ export namespace dataproc_v1beta2 { */ export interface Schema$SoftwareConfig { /** - * 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 Debian version. + * Optional. The version of software inside the cluster. It must be one of the supported 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 Debian version. */ imageVersion?: string | null; /** @@ -1325,7 +1283,7 @@ export namespace dataproc_v1beta2 { properties?: {[key: string]: string} | null; } /** - * A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. The specification of the main method to call to drive the job. Specify either the jar file that contains the main class or the main class name. To pass both a main jar and a main class in that jar, add the jar to CommonJob.jar_file_uris, and then specify the main class name in main_class. + * A Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. The specification of the main method to call to drive the job. Specify either the jar file that contains the main class or the main class name. To pass both a main jar and a main class in that jar, add the jar to CommonJob.jar_file_uris, and then specify the main class name in main_class. */ export interface Schema$SparkJob { /** @@ -1357,12 +1315,12 @@ export namespace dataproc_v1beta2 { */ mainJarFileUri?: string | null; /** - * Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. + * Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. */ properties?: {[key: string]: string} | null; } /** - * A Cloud Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. + * A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. */ export interface Schema$SparkRJob { /** @@ -1386,12 +1344,12 @@ export namespace dataproc_v1beta2 { */ mainRFileUri?: string | null; /** - * Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. + * Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. */ properties?: {[key: string]: string} | null; } /** - * A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. + * A Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. */ export interface Schema$SparkSqlJob { /** @@ -1403,7 +1361,7 @@ export namespace dataproc_v1beta2 { */ loggingConfig?: Schema$LoggingConfig; /** - * Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. + * Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten. */ properties?: {[key: string]: string} | null; /** @@ -1507,7 +1465,7 @@ export namespace dataproc_v1beta2 { nodes?: Schema$WorkflowNode[]; } /** - * A Cloud Dataproc workflow template resource. + * A Dataproc workflow template resource. */ export interface Schema$WorkflowMetadata { /** @@ -1581,7 +1539,7 @@ export namespace dataproc_v1beta2 { stepId?: string | null; } /** - * A Cloud Dataproc workflow template resource. + * A Dataproc workflow template resource. */ export interface Schema$WorkflowTemplate { /** @@ -1651,7 +1609,7 @@ export namespace dataproc_v1beta2 { */ state?: string | null; /** - * Optional. Output only. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access. + * Output only. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access. */ trackingUrl?: string | null; } @@ -4128,7 +4086,7 @@ export namespace dataproc_v1beta2 { * * @param {object} params Parameters for request * @param {string} params.projectId Required. The ID of the Google Cloud Platform project that the cluster belongs to. - * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. + * @param {string} params.region Required. The Dataproc region in which to handle the request. * @param {string=} params.requestId Optional. A unique id used to identify the request. If the server receives two CreateClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. * @param {().Cluster} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4207,7 +4165,7 @@ export namespace dataproc_v1beta2 { * @param {string} params.clusterName Required. The cluster name. * @param {string=} params.clusterUuid Optional. Specifying the cluster_uuid means the RPC should fail (with error NOT_FOUND) if cluster with specified UUID does not exist. * @param {string} params.projectId Required. The ID of the Google Cloud Platform project that the cluster belongs to. - * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. + * @param {string} params.region Required. The Dataproc region in which to handle the request. * @param {string=} params.requestId Optional. A unique id used to identify the request. If the server receives two DeleteClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4284,7 +4242,7 @@ export namespace dataproc_v1beta2 { * @param {object} params Parameters for request * @param {string} params.clusterName Required. The cluster name. * @param {string} params.projectId Required. The ID of the Google Cloud Platform project that the cluster belongs to. - * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. + * @param {string} params.region Required. The Dataproc region in which to handle the request. * @param {().DiagnoseClusterRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4361,7 +4319,7 @@ export namespace dataproc_v1beta2 { * @param {object} params Parameters for request * @param {string} params.clusterName Required. The cluster name. * @param {string} params.projectId Required. The ID of the Google Cloud Platform project that the cluster belongs to. - * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. + * @param {string} params.region Required. The Dataproc region in which to handle the request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4510,7 +4468,7 @@ export namespace dataproc_v1beta2 { * @param {integer=} params.pageSize Optional. The standard List page size. * @param {string=} params.pageToken Optional. The standard List page token. * @param {string} params.projectId Required. The ID of the Google Cloud Platform project that the cluster belongs to. - * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. + * @param {string} params.region Required. The Dataproc region in which to handle the request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4587,9 +4545,9 @@ export namespace dataproc_v1beta2 { * * @param {object} params Parameters for request * @param {string} params.clusterName Required. The cluster name. - * @param {string=} params.gracefulDecommissionTimeout Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day.Only supported on Dataproc image versions 1.2 and higher. + * @param {string=} params.gracefulDecommissionTimeout Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Only supported on Dataproc image versions 1.2 and higher. * @param {string} params.projectId Required. The ID of the Google Cloud Platform project the cluster belongs to. - * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. + * @param {string} params.region Required. The Dataproc region in which to handle the request. * @param {string=} params.requestId Optional. A unique id used to identify the request. If the server receives two UpdateClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. * @param {string=} params.updateMask Required. Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as config.worker_config.num_instances, and the PATCH request body would specify the new value, as follows: { "config":{ "workerConfig":{ "numInstances":"5" } } } Similarly, to change the number of preemptible workers in a cluster to 5, the update_mask parameter would be config.secondary_worker_config.num_instances, and the PATCH request body would be set as follows: { "config":{ "secondaryWorkerConfig":{ "numInstances":"5" } } } Note: currently only the following fields can be updated:
MaskPurpose
labelsUpdates labels
config.worker_config.num_instancesResize primary worker group
config.secondary_worker_config.num_instancesResize secondary worker group
config.lifecycle_config.auto_delete_ttlReset MAX TTL duration
config.lifecycle_config.auto_delete_timeUpdate MAX TTL deletion timestamp
config.lifecycle_config.idle_delete_ttlUpdate Idle TTL duration
config.autoscaling_config.policy_uriUse, stop using, or change autoscaling policies
* @param {().Cluster} params.requestBody Request body data @@ -4827,7 +4785,7 @@ export namespace dataproc_v1beta2 { */ projectId?: string; /** - * Required. The Cloud Dataproc region in which to handle the request. + * Required. The Dataproc region in which to handle the request. */ region?: string; /** @@ -4860,7 +4818,7 @@ export namespace dataproc_v1beta2 { */ projectId?: string; /** - * Required. The Cloud Dataproc region in which to handle the request. + * Required. The Dataproc region in which to handle the request. */ region?: string; /** @@ -4884,7 +4842,7 @@ export namespace dataproc_v1beta2 { */ projectId?: string; /** - * Required. The Cloud Dataproc region in which to handle the request. + * Required. The Dataproc region in which to handle the request. */ region?: string; @@ -4909,7 +4867,7 @@ export namespace dataproc_v1beta2 { */ projectId?: string; /** - * Required. The Cloud Dataproc region in which to handle the request. + * Required. The Dataproc region in which to handle the request. */ region?: string; } @@ -4953,7 +4911,7 @@ export namespace dataproc_v1beta2 { */ projectId?: string; /** - * Required. The Cloud Dataproc region in which to handle the request. + * Required. The Dataproc region in which to handle the request. */ region?: string; } @@ -4969,7 +4927,7 @@ export namespace dataproc_v1beta2 { */ clusterName?: string; /** - * Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day.Only supported on Dataproc image versions 1.2 and higher. + * Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Only supported on Dataproc image versions 1.2 and higher. */ gracefulDecommissionTimeout?: string; /** @@ -4977,7 +4935,7 @@ export namespace dataproc_v1beta2 { */ projectId?: string; /** - * Required. The Cloud Dataproc region in which to handle the request. + * Required. The Dataproc region in which to handle the request. */ region?: string; /** @@ -5044,7 +5002,7 @@ export namespace dataproc_v1beta2 { * @param {object} params Parameters for request * @param {string} params.jobId Required. The job ID. * @param {string} params.projectId Required. The ID of the Google Cloud Platform project that the job belongs to. - * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. + * @param {string} params.region Required. The Dataproc region in which to handle the request. * @param {().CancelJobRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5119,7 +5077,7 @@ export namespace dataproc_v1beta2 { * @param {object} params Parameters for request * @param {string} params.jobId Required. The job ID. * @param {string} params.projectId Required. The ID of the Google Cloud Platform project that the job belongs to. - * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. + * @param {string} params.region Required. The Dataproc region in which to handle the request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5193,7 +5151,7 @@ export namespace dataproc_v1beta2 { * @param {object} params Parameters for request * @param {string} params.jobId Required. The job ID. * @param {string} params.projectId Required. The ID of the Google Cloud Platform project that the job belongs to. - * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. + * @param {string} params.region Required. The Dataproc region in which to handle the request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5344,7 +5302,7 @@ export namespace dataproc_v1beta2 { * @param {integer=} params.pageSize Optional. The number of results to return in each response. * @param {string=} params.pageToken Optional. The page token, returned by a previous call, to request the next page of results. * @param {string} params.projectId Required. The ID of the Google Cloud Platform project that the job belongs to. - * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. + * @param {string} params.region Required. The Dataproc region in which to handle the request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5419,7 +5377,7 @@ export namespace dataproc_v1beta2 { * @param {object} params Parameters for request * @param {string} params.jobId Required. The job ID. * @param {string} params.projectId Required. The ID of the Google Cloud Platform project that the job belongs to. - * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. + * @param {string} params.region Required. The Dataproc region in which to handle the request. * @param {string=} params.updateMask Required. Specifies the path, relative to Job, of the field to update. For example, to update the labels of a Job the update_mask parameter would be specified as labels, and the PATCH request body would specify the new value. Note: Currently, labels is the only field that can be updated. * @param {().Job} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5567,7 +5525,7 @@ export namespace dataproc_v1beta2 { * * @param {object} params Parameters for request * @param {string} params.projectId Required. The ID of the Google Cloud Platform project that the job belongs to. - * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. + * @param {string} params.region Required. The Dataproc region in which to handle the request. * @param {().SubmitJobRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5732,7 +5690,7 @@ export namespace dataproc_v1beta2 { */ projectId?: string; /** - * Required. The Cloud Dataproc region in which to handle the request. + * Required. The Dataproc region in which to handle the request. */ region?: string; @@ -5757,7 +5715,7 @@ export namespace dataproc_v1beta2 { */ projectId?: string; /** - * Required. The Cloud Dataproc region in which to handle the request. + * Required. The Dataproc region in which to handle the request. */ region?: string; } @@ -5777,7 +5735,7 @@ export namespace dataproc_v1beta2 { */ projectId?: string; /** - * Required. The Cloud Dataproc region in which to handle the request. + * Required. The Dataproc region in which to handle the request. */ region?: string; } @@ -5829,7 +5787,7 @@ export namespace dataproc_v1beta2 { */ projectId?: string; /** - * Required. The Cloud Dataproc region in which to handle the request. + * Required. The Dataproc region in which to handle the request. */ region?: string; } @@ -5849,7 +5807,7 @@ export namespace dataproc_v1beta2 { */ projectId?: string; /** - * Required. The Cloud Dataproc region in which to handle the request. + * Required. The Dataproc region in which to handle the request. */ region?: string; /** @@ -5891,7 +5849,7 @@ export namespace dataproc_v1beta2 { */ projectId?: string; /** - * Required. The Cloud Dataproc region in which to handle the request. + * Required. The Dataproc region in which to handle the request. */ region?: string; diff --git a/src/apis/datastore/v1.ts b/src/apis/datastore/v1.ts index f3d57173810..4292905811b 100644 --- a/src/apis/datastore/v1.ts +++ b/src/apis/datastore/v1.ts @@ -120,7 +120,7 @@ export namespace datastore_v1 { */ export interface Schema$AllocateIdsRequest { /** - * A list of keys with incomplete key paths for which to allocate IDs. No key may be reserved/read-only. + * Required. A list of keys with incomplete key paths for which to allocate IDs. No key may be reserved/read-only. */ keys?: Schema$Key[]; } @@ -436,7 +436,7 @@ export namespace datastore_v1 { */ labels?: {[key: string]: string} | null; /** - * Location for the export metadata and data files. The full resource URL of the external storage location. Currently, only Google Cloud Storage is supported. So output_url_prefix should be of the form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name of the Cloud Storage bucket and `NAMESPACE_PATH` is an optional Cloud Storage namespace path (this is not a Cloud Datastore namespace). For more information about Cloud Storage namespace paths, see [Object name considerations](https://cloud.google.com/storage/docs/naming#object-considerations). The resulting files will be nested deeper than the specified URL prefix. The final output URL will be provided in the google.datastore.admin.v1.ExportEntitiesResponse.output_url field. That value should be used for subsequent ImportEntities operations. By nesting the data files deeper, the same Cloud Storage bucket can be used in multiple ExportEntities operations without conflict. + * Required. Location for the export metadata and data files. The full resource URL of the external storage location. Currently, only Google Cloud Storage is supported. So output_url_prefix should be of the form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name of the Cloud Storage bucket and `NAMESPACE_PATH` is an optional Cloud Storage namespace path (this is not a Cloud Datastore namespace). For more information about Cloud Storage namespace paths, see [Object name considerations](https://cloud.google.com/storage/docs/naming#object-considerations). The resulting files will be nested deeper than the specified URL prefix. The final output URL will be provided in the google.datastore.admin.v1.ExportEntitiesResponse.output_url field. That value should be used for subsequent ImportEntities operations. By nesting the data files deeper, the same Cloud Storage bucket can be used in multiple ExportEntities operations without conflict. */ outputUrlPrefix?: string | null; } @@ -483,7 +483,7 @@ export namespace datastore_v1 { */ entityFilter?: Schema$GoogleDatastoreAdminV1EntityFilter; /** - * The full resource URL of the external storage location. Currently, only Google Cloud Storage is supported. So input_url should be of the form: `gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE`, where `BUCKET_NAME` is the name of the Cloud Storage bucket, `NAMESPACE_PATH` is an optional Cloud Storage namespace path (this is not a Cloud Datastore namespace), and `OVERALL_EXPORT_METADATA_FILE` is the metadata file written by the ExportEntities operation. For more information about Cloud Storage namespace paths, see [Object name considerations](https://cloud.google.com/storage/docs/naming#object-considerations). For more information, see google.datastore.admin.v1.ExportEntitiesResponse.output_url. + * Required. The full resource URL of the external storage location. Currently, only Google Cloud Storage is supported. So input_url should be of the form: `gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE`, where `BUCKET_NAME` is the name of the Cloud Storage bucket, `NAMESPACE_PATH` is an optional Cloud Storage namespace path (this is not a Cloud Datastore namespace), and `OVERALL_EXPORT_METADATA_FILE` is the metadata file written by the ExportEntities operation. For more information about Cloud Storage namespace paths, see [Object name considerations](https://cloud.google.com/storage/docs/naming#object-considerations). For more information, see google.datastore.admin.v1.ExportEntitiesResponse.output_url. */ inputUrl?: string | null; /** @@ -496,27 +496,27 @@ export namespace datastore_v1 { */ export interface Schema$GoogleDatastoreAdminV1Index { /** - * The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED. Required. + * Required. The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED. */ ancestor?: string | null; /** - * The resource ID of the index. Output only. + * Output only. The resource ID of the index. */ indexId?: string | null; /** - * The entity kind to which this index applies. Required. + * Required. The entity kind to which this index applies. */ kind?: string | null; /** - * Project ID. Output only. + * Output only. Project ID. */ projectId?: string | null; /** - * An ordered sequence of property names and their index attributes. Required. + * Required. An ordered sequence of property names and their index attributes. */ properties?: Schema$GoogleDatastoreAdminV1IndexedProperty[]; /** - * The state of the index. Output only. + * Output only. The state of the index. */ state?: string | null; } @@ -525,11 +525,11 @@ export namespace datastore_v1 { */ export interface Schema$GoogleDatastoreAdminV1IndexedProperty { /** - * The indexed property's direction. Must not be DIRECTION_UNSPECIFIED. Required. + * Required. The indexed property's direction. Must not be DIRECTION_UNSPECIFIED. */ direction?: string | null; /** - * The property name to index. Required. + * Required. The property name to index. */ name?: string | null; } @@ -688,7 +688,7 @@ export namespace datastore_v1 { */ export interface Schema$LookupRequest { /** - * Keys of entities to look up. + * Required. Keys of entities to look up. */ keys?: Schema$Key[]; /** @@ -942,7 +942,7 @@ export namespace datastore_v1 { */ databaseId?: string | null; /** - * A list of keys with complete key paths whose numeric IDs should not be auto-allocated. + * Required. A list of keys with complete key paths whose numeric IDs should not be auto-allocated. */ keys?: Schema$Key[]; } @@ -955,7 +955,7 @@ export namespace datastore_v1 { */ export interface Schema$RollbackRequest { /** - * The transaction identifier, returned by a call to Datastore.BeginTransaction. + * Required. The transaction identifier, returned by a call to Datastore.BeginTransaction. */ transaction?: string | null; } @@ -1102,7 +1102,7 @@ export namespace datastore_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.projectId The ID of the project against which to make the request. + * @param {string} params.projectId Required. The ID of the project against which to make the request. * @param {().AllocateIdsRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1179,7 +1179,7 @@ export namespace datastore_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.projectId The ID of the project against which to make the request. + * @param {string} params.projectId Required. The ID of the project against which to make the request. * @param {().BeginTransactionRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1257,7 +1257,7 @@ export namespace datastore_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.projectId The ID of the project against which to make the request. + * @param {string} params.projectId Required. The ID of the project against which to make the request. * @param {().CommitRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1331,7 +1331,7 @@ export namespace datastore_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.projectId Project ID against which to make the request. + * @param {string} params.projectId Required. Project ID against which to make the request. * @param {().GoogleDatastoreAdminV1ExportEntitiesRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1412,7 +1412,7 @@ export namespace datastore_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.projectId Project ID against which to make the request. + * @param {string} params.projectId Required. Project ID against which to make the request. * @param {().GoogleDatastoreAdminV1ImportEntitiesRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1493,7 +1493,7 @@ export namespace datastore_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.projectId The ID of the project against which to make the request. + * @param {string} params.projectId Required. The ID of the project against which to make the request. * @param {().LookupRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1562,12 +1562,12 @@ export namespace datastore_v1 { /** * datastore.projects.reserveIds - * @desc Prevents the supplied keys' IDs from being auto-allocated by Cloud Datastore. Used for imports only; other workloads are not supported. + * @desc Prevents the supplied keys' IDs from being auto-allocated by Cloud Datastore. * @alias datastore.projects.reserveIds * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.projectId The ID of the project against which to make the request. + * @param {string} params.projectId Required. The ID of the project against which to make the request. * @param {().ReserveIdsRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1642,7 +1642,7 @@ export namespace datastore_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.projectId The ID of the project against which to make the request. + * @param {string} params.projectId Required. The ID of the project against which to make the request. * @param {().RollbackRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1717,7 +1717,7 @@ export namespace datastore_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.projectId The ID of the project against which to make the request. + * @param {string} params.projectId Required. The ID of the project against which to make the request. * @param {().RunQueryRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1794,7 +1794,7 @@ export namespace datastore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the project against which to make the request. + * Required. The ID of the project against which to make the request. */ projectId?: string; @@ -1811,7 +1811,7 @@ export namespace datastore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the project against which to make the request. + * Required. The ID of the project against which to make the request. */ projectId?: string; @@ -1827,7 +1827,7 @@ export namespace datastore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the project against which to make the request. + * Required. The ID of the project against which to make the request. */ projectId?: string; @@ -1843,7 +1843,7 @@ export namespace datastore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Project ID against which to make the request. + * Required. Project ID against which to make the request. */ projectId?: string; @@ -1859,7 +1859,7 @@ export namespace datastore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Project ID against which to make the request. + * Required. Project ID against which to make the request. */ projectId?: string; @@ -1875,7 +1875,7 @@ export namespace datastore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the project against which to make the request. + * Required. The ID of the project against which to make the request. */ projectId?: string; @@ -1892,7 +1892,7 @@ export namespace datastore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the project against which to make the request. + * Required. The ID of the project against which to make the request. */ projectId?: string; @@ -1909,7 +1909,7 @@ export namespace datastore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the project against which to make the request. + * Required. The ID of the project against which to make the request. */ projectId?: string; @@ -1926,7 +1926,7 @@ export namespace datastore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the project against which to make the request. + * Required. The ID of the project against which to make the request. */ projectId?: string; diff --git a/src/apis/datastore/v1beta3.ts b/src/apis/datastore/v1beta3.ts index 4c69d8f5544..3a26ca1bc89 100644 --- a/src/apis/datastore/v1beta3.ts +++ b/src/apis/datastore/v1beta3.ts @@ -120,7 +120,7 @@ export namespace datastore_v1beta3 { */ export interface Schema$AllocateIdsRequest { /** - * A list of keys with incomplete key paths for which to allocate IDs. No key may be reserved/read-only. + * Required. A list of keys with incomplete key paths for which to allocate IDs. No key may be reserved/read-only. */ keys?: Schema$Key[]; } @@ -557,7 +557,7 @@ export namespace datastore_v1beta3 { */ export interface Schema$LookupRequest { /** - * Keys of entities to look up. + * Required. Keys of entities to look up. */ keys?: Schema$Key[]; /** @@ -811,7 +811,7 @@ export namespace datastore_v1beta3 { */ databaseId?: string | null; /** - * A list of keys with complete key paths whose numeric IDs should not be auto-allocated. + * Required. A list of keys with complete key paths whose numeric IDs should not be auto-allocated. */ keys?: Schema$Key[]; } @@ -824,7 +824,7 @@ export namespace datastore_v1beta3 { */ export interface Schema$RollbackRequest { /** - * The transaction identifier, returned by a call to Datastore.BeginTransaction. + * Required. The transaction identifier, returned by a call to Datastore.BeginTransaction. */ transaction?: string | null; } @@ -950,7 +950,7 @@ export namespace datastore_v1beta3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.projectId The ID of the project against which to make the request. + * @param {string} params.projectId Required. The ID of the project against which to make the request. * @param {().AllocateIdsRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1026,7 +1026,7 @@ export namespace datastore_v1beta3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.projectId The ID of the project against which to make the request. + * @param {string} params.projectId Required. The ID of the project against which to make the request. * @param {().BeginTransactionRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1104,7 +1104,7 @@ export namespace datastore_v1beta3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.projectId The ID of the project against which to make the request. + * @param {string} params.projectId Required. The ID of the project against which to make the request. * @param {().CommitRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1178,7 +1178,7 @@ export namespace datastore_v1beta3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.projectId The ID of the project against which to make the request. + * @param {string} params.projectId Required. The ID of the project against which to make the request. * @param {().LookupRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1247,12 +1247,12 @@ export namespace datastore_v1beta3 { /** * datastore.projects.reserveIds - * @desc Prevents the supplied keys' IDs from being auto-allocated by Cloud Datastore. Used for imports only; other workloads are not supported. + * @desc Prevents the supplied keys' IDs from being auto-allocated by Cloud Datastore. * @alias datastore.projects.reserveIds * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.projectId The ID of the project against which to make the request. + * @param {string} params.projectId Required. The ID of the project against which to make the request. * @param {().ReserveIdsRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1327,7 +1327,7 @@ export namespace datastore_v1beta3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.projectId The ID of the project against which to make the request. + * @param {string} params.projectId Required. The ID of the project against which to make the request. * @param {().RollbackRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1402,7 +1402,7 @@ export namespace datastore_v1beta3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.projectId The ID of the project against which to make the request. + * @param {string} params.projectId Required. The ID of the project against which to make the request. * @param {().RunQueryRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1479,7 +1479,7 @@ export namespace datastore_v1beta3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the project against which to make the request. + * Required. The ID of the project against which to make the request. */ projectId?: string; @@ -1496,7 +1496,7 @@ export namespace datastore_v1beta3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the project against which to make the request. + * Required. The ID of the project against which to make the request. */ projectId?: string; @@ -1512,7 +1512,7 @@ export namespace datastore_v1beta3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the project against which to make the request. + * Required. The ID of the project against which to make the request. */ projectId?: string; @@ -1528,7 +1528,7 @@ export namespace datastore_v1beta3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the project against which to make the request. + * Required. The ID of the project against which to make the request. */ projectId?: string; @@ -1545,7 +1545,7 @@ export namespace datastore_v1beta3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the project against which to make the request. + * Required. The ID of the project against which to make the request. */ projectId?: string; @@ -1562,7 +1562,7 @@ export namespace datastore_v1beta3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the project against which to make the request. + * Required. The ID of the project against which to make the request. */ projectId?: string; @@ -1579,7 +1579,7 @@ export namespace datastore_v1beta3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the project against which to make the request. + * Required. The ID of the project against which to make the request. */ projectId?: string; diff --git a/src/apis/dfareporting/index.ts b/src/apis/dfareporting/index.ts index 8e6c581edb1..9f9ce59e5bc 100644 --- a/src/apis/dfareporting/index.ts +++ b/src/apis/dfareporting/index.ts @@ -14,19 +14,31 @@ /*! THIS FILE IS AUTO-GENERATED */ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; +import {dfareporting_v3_3} from './v3.3'; import {dfareporting_v3_4} from './v3.4'; export const VERSIONS = { + 'v3.3': dfareporting_v3_3.Dfareporting, 'v3.4': dfareporting_v3_4.Dfareporting, }; +export function dfareporting(version: 'v3.3'): dfareporting_v3_3.Dfareporting; +export function dfareporting( + options: dfareporting_v3_3.Options +): dfareporting_v3_3.Dfareporting; export function dfareporting(version: 'v3.4'): dfareporting_v3_4.Dfareporting; export function dfareporting( options: dfareporting_v3_4.Options ): dfareporting_v3_4.Dfareporting; -export function dfareporting( +export function dfareporting< + T = dfareporting_v3_3.Dfareporting | dfareporting_v3_4.Dfareporting +>( this: GoogleConfigurable, - versionOrOptions: 'v3.4' | dfareporting_v3_4.Options + versionOrOptions: + | 'v3.3' + | dfareporting_v3_3.Options + | 'v3.4' + | dfareporting_v3_4.Options ) { return getAPI('dfareporting', versionOrOptions, VERSIONS, this); } diff --git a/src/apis/dfareporting/v3.3.ts b/src/apis/dfareporting/v3.3.ts new file mode 100644 index 00000000000..ad3bb6b57fe --- /dev/null +++ b/src/apis/dfareporting/v3.3.ts @@ -0,0 +1,27438 @@ +// Copyright 2019 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, +} from 'google-auth-library'; +import { + GoogleConfigurable, + createAPIRequest, + MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace dfareporting_v3_3 { + export interface Options extends GlobalOptions { + version: 'v3.3'; + } + + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + + /** + * DCM/DFA Reporting And Trafficking API + * + * Manages your DoubleClick Campaign Manager ad campaigns and reports. + * + * @example + * const {google} = require('googleapis'); + * const dfareporting = google.dfareporting('v3.3'); + * + * @namespace dfareporting + * @type {Function} + * @version v3.3 + * @variation v3.3 + * @param {object=} options Options for Dfareporting + */ + export class Dfareporting { + context: APIRequestContext; + accountActiveAdSummaries: Resource$Accountactiveadsummaries; + accountPermissionGroups: Resource$Accountpermissiongroups; + accountPermissions: Resource$Accountpermissions; + accounts: Resource$Accounts; + accountUserProfiles: Resource$Accountuserprofiles; + ads: Resource$Ads; + advertiserGroups: Resource$Advertisergroups; + advertiserLandingPages: Resource$Advertiserlandingpages; + advertisers: Resource$Advertisers; + browsers: Resource$Browsers; + campaignCreativeAssociations: Resource$Campaigncreativeassociations; + campaigns: Resource$Campaigns; + changeLogs: Resource$Changelogs; + cities: Resource$Cities; + connectionTypes: Resource$Connectiontypes; + contentCategories: Resource$Contentcategories; + conversions: Resource$Conversions; + countries: Resource$Countries; + creativeAssets: Resource$Creativeassets; + creativeFields: Resource$Creativefields; + creativeFieldValues: Resource$Creativefieldvalues; + creativeGroups: Resource$Creativegroups; + creatives: Resource$Creatives; + dimensionValues: Resource$Dimensionvalues; + directorySites: Resource$Directorysites; + dynamicTargetingKeys: Resource$Dynamictargetingkeys; + eventTags: Resource$Eventtags; + files: Resource$Files; + floodlightActivities: Resource$Floodlightactivities; + floodlightActivityGroups: Resource$Floodlightactivitygroups; + floodlightConfigurations: Resource$Floodlightconfigurations; + inventoryItems: Resource$Inventoryitems; + languages: Resource$Languages; + metros: Resource$Metros; + mobileApps: Resource$Mobileapps; + mobileCarriers: Resource$Mobilecarriers; + operatingSystems: Resource$Operatingsystems; + operatingSystemVersions: Resource$Operatingsystemversions; + orderDocuments: Resource$Orderdocuments; + orders: Resource$Orders; + placementGroups: Resource$Placementgroups; + placements: Resource$Placements; + placementStrategies: Resource$Placementstrategies; + platformTypes: Resource$Platformtypes; + postalCodes: Resource$Postalcodes; + projects: Resource$Projects; + regions: Resource$Regions; + remarketingLists: Resource$Remarketinglists; + remarketingListShares: Resource$Remarketinglistshares; + reports: Resource$Reports; + sites: Resource$Sites; + sizes: Resource$Sizes; + subaccounts: Resource$Subaccounts; + targetableRemarketingLists: Resource$Targetableremarketinglists; + targetingTemplates: Resource$Targetingtemplates; + userProfiles: Resource$Userprofiles; + userRolePermissionGroups: Resource$Userrolepermissiongroups; + userRolePermissions: Resource$Userrolepermissions; + userRoles: Resource$Userroles; + videoFormats: Resource$Videoformats; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.accountActiveAdSummaries = new Resource$Accountactiveadsummaries( + this.context + ); + this.accountPermissionGroups = new Resource$Accountpermissiongroups( + this.context + ); + this.accountPermissions = new Resource$Accountpermissions(this.context); + this.accounts = new Resource$Accounts(this.context); + this.accountUserProfiles = new Resource$Accountuserprofiles(this.context); + this.ads = new Resource$Ads(this.context); + this.advertiserGroups = new Resource$Advertisergroups(this.context); + this.advertiserLandingPages = new Resource$Advertiserlandingpages( + this.context + ); + this.advertisers = new Resource$Advertisers(this.context); + this.browsers = new Resource$Browsers(this.context); + this.campaignCreativeAssociations = new Resource$Campaigncreativeassociations( + this.context + ); + this.campaigns = new Resource$Campaigns(this.context); + this.changeLogs = new Resource$Changelogs(this.context); + this.cities = new Resource$Cities(this.context); + this.connectionTypes = new Resource$Connectiontypes(this.context); + this.contentCategories = new Resource$Contentcategories(this.context); + this.conversions = new Resource$Conversions(this.context); + this.countries = new Resource$Countries(this.context); + this.creativeAssets = new Resource$Creativeassets(this.context); + this.creativeFields = new Resource$Creativefields(this.context); + this.creativeFieldValues = new Resource$Creativefieldvalues(this.context); + this.creativeGroups = new Resource$Creativegroups(this.context); + this.creatives = new Resource$Creatives(this.context); + this.dimensionValues = new Resource$Dimensionvalues(this.context); + this.directorySites = new Resource$Directorysites(this.context); + this.dynamicTargetingKeys = new Resource$Dynamictargetingkeys( + this.context + ); + this.eventTags = new Resource$Eventtags(this.context); + this.files = new Resource$Files(this.context); + this.floodlightActivities = new Resource$Floodlightactivities( + this.context + ); + this.floodlightActivityGroups = new Resource$Floodlightactivitygroups( + this.context + ); + this.floodlightConfigurations = new Resource$Floodlightconfigurations( + this.context + ); + this.inventoryItems = new Resource$Inventoryitems(this.context); + this.languages = new Resource$Languages(this.context); + this.metros = new Resource$Metros(this.context); + this.mobileApps = new Resource$Mobileapps(this.context); + this.mobileCarriers = new Resource$Mobilecarriers(this.context); + this.operatingSystems = new Resource$Operatingsystems(this.context); + this.operatingSystemVersions = new Resource$Operatingsystemversions( + this.context + ); + this.orderDocuments = new Resource$Orderdocuments(this.context); + this.orders = new Resource$Orders(this.context); + this.placementGroups = new Resource$Placementgroups(this.context); + this.placements = new Resource$Placements(this.context); + this.placementStrategies = new Resource$Placementstrategies(this.context); + this.platformTypes = new Resource$Platformtypes(this.context); + this.postalCodes = new Resource$Postalcodes(this.context); + this.projects = new Resource$Projects(this.context); + this.regions = new Resource$Regions(this.context); + this.remarketingLists = new Resource$Remarketinglists(this.context); + this.remarketingListShares = new Resource$Remarketinglistshares( + this.context + ); + this.reports = new Resource$Reports(this.context); + this.sites = new Resource$Sites(this.context); + this.sizes = new Resource$Sizes(this.context); + this.subaccounts = new Resource$Subaccounts(this.context); + this.targetableRemarketingLists = new Resource$Targetableremarketinglists( + this.context + ); + this.targetingTemplates = new Resource$Targetingtemplates(this.context); + this.userProfiles = new Resource$Userprofiles(this.context); + this.userRolePermissionGroups = new Resource$Userrolepermissiongroups( + this.context + ); + this.userRolePermissions = new Resource$Userrolepermissions(this.context); + this.userRoles = new Resource$Userroles(this.context); + this.videoFormats = new Resource$Videoformats(this.context); + } + } + + /** + * Contains properties of a Campaign Manager account. + */ + export interface Schema$Account { + /** + * Account permissions assigned to this account. + */ + accountPermissionIds?: string[] | null; + /** + * Profile for this account. This is a read-only field that can be left blank. + */ + accountProfile?: string | null; + /** + * Whether this account is active. + */ + active?: boolean | null; + /** + * Maximum number of active ads allowed for this account. + */ + activeAdsLimitTier?: string | null; + /** + * Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions. + */ + activeViewOptOut?: boolean | null; + /** + * User role permissions available to the user roles of this account. + */ + availablePermissionIds?: string[] | null; + /** + * ID of the country associated with this account. + */ + countryId?: string | null; + /** + * ID of currency associated with this account. This is a required field. Acceptable values are: - "1" for USD - "2" for GBP - "3" for ESP - "4" for SEK - "5" for CAD - "6" for JPY - "7" for DEM - "8" for AUD - "9" for FRF - "10" for ITL - "11" for DKK - "12" for NOK - "13" for FIM - "14" for ZAR - "15" for IEP - "16" for NLG - "17" for EUR - "18" for KRW - "19" for TWD - "20" for SGD - "21" for CNY - "22" for HKD - "23" for NZD - "24" for MYR - "25" for BRL - "26" for PTE - "27" for MXP - "28" for CLP - "29" for TRY - "30" for ARS - "31" for PEN - "32" for ILS - "33" for CHF - "34" for VEF - "35" for COP - "36" for GTQ - "37" for PLN - "39" for INR - "40" for THB - "41" for IDR - "42" for CZK - "43" for RON - "44" for HUF - "45" for RUB - "46" for AED - "47" for BGN - "48" for HRK - "49" for MXN - "50" for NGN - "51" for EGP + */ + currencyId?: string | null; + /** + * Default placement dimensions for this account. + */ + defaultCreativeSizeId?: string | null; + /** + * Description of this account. + */ + description?: string | null; + /** + * ID of this account. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#account". + */ + kind?: string | null; + /** + * Locale of this account. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional) + */ + locale?: string | null; + /** + * Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1. + */ + maximumImageSize?: string | null; + /** + * Name of this account. This is a required field, and must be less than 128 characters long and be globally unique. + */ + name?: string | null; + /** + * Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default. + */ + nielsenOcrEnabled?: boolean | null; + /** + * Reporting configuration of this account. + */ + reportsConfiguration?: Schema$ReportsConfiguration; + /** + * Share Path to Conversion reports with Twitter. + */ + shareReportsWithTwitter?: boolean | null; + /** + * File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive. + */ + teaserSizeLimit?: string | null; + } + /** + * Gets a summary of active ads in an account. + */ + export interface Schema$AccountActiveAdSummary { + /** + * ID of the account. + */ + accountId?: string | null; + /** + * Ads that have been activated for the account + */ + activeAds?: string | null; + /** + * Maximum number of active ads allowed for the account. + */ + activeAdsLimitTier?: string | null; + /** + * Ads that can be activated for the account. + */ + availableAds?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountActiveAdSummary". + */ + kind?: string | null; + } + /** + * AccountPermissions contains information about a particular account permission. Some features of Campaign Manager require an account permission to be present in the account. + */ + export interface Schema$AccountPermission { + /** + * Account profiles associated with this account permission. Possible values are: - "ACCOUNT_PROFILE_BASIC" - "ACCOUNT_PROFILE_STANDARD" + */ + accountProfiles?: string[] | null; + /** + * ID of this account permission. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermission". + */ + kind?: string | null; + /** + * Administrative level required to enable this account permission. + */ + level?: string | null; + /** + * Name of this account permission. + */ + name?: string | null; + /** + * Permission group of this account permission. + */ + permissionGroupId?: string | null; + } + /** + * AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions. + */ + export interface Schema$AccountPermissionGroup { + /** + * ID of this account permission group. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroup". + */ + kind?: string | null; + /** + * Name of this account permission group. + */ + name?: string | null; + } + /** + * Account Permission Group List Response + */ + export interface Schema$AccountPermissionGroupsListResponse { + /** + * Account permission group collection. + */ + accountPermissionGroups?: Schema$AccountPermissionGroup[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroupsListResponse". + */ + kind?: string | null; + } + /** + * Account Permission List Response + */ + export interface Schema$AccountPermissionsListResponse { + /** + * Account permission collection. + */ + accountPermissions?: Schema$AccountPermission[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionsListResponse". + */ + kind?: string | null; + } + /** + * Account List Response + */ + export interface Schema$AccountsListResponse { + /** + * Account collection. + */ + accounts?: Schema$Account[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountsListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API. + */ + export interface Schema$AccountUserProfile { + /** + * Account ID of the user profile. This is a read-only field that can be left blank. + */ + accountId?: string | null; + /** + * Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable. + */ + active?: boolean | null; + /** + * Filter that describes which advertisers are visible to the user profile. + */ + advertiserFilter?: Schema$ObjectFilter; + /** + * Filter that describes which campaigns are visible to the user profile. + */ + campaignFilter?: Schema$ObjectFilter; + /** + * Comments for this user profile. + */ + comments?: string | null; + /** + * Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion. + */ + email?: string | null; + /** + * ID of the user profile. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile". + */ + kind?: string | null; + /** + * Locale of the user profile. This is a required field. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional) + */ + locale?: string | null; + /** + * Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,". + */ + name?: string | null; + /** + * Filter that describes which sites are visible to the user profile. + */ + siteFilter?: Schema$ObjectFilter; + /** + * Subaccount ID of the user profile. This is a read-only field that can be left blank. + */ + subaccountId?: string | null; + /** + * Trafficker type of this user profile. This is a read-only field. + */ + traffickerType?: string | null; + /** + * User type of the user profile. This is a read-only field that can be left blank. + */ + userAccessType?: string | null; + /** + * Filter that describes which user roles are visible to the user profile. + */ + userRoleFilter?: Schema$ObjectFilter; + /** + * User role ID of the user profile. This is a required field. + */ + userRoleId?: string | null; + } + /** + * Account User Profile List Response + */ + export interface Schema$AccountUserProfilesListResponse { + /** + * Account user profile collection. + */ + accountUserProfiles?: Schema$AccountUserProfile[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfilesListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * Represents an activity group. + */ + export interface Schema$Activities { + /** + * List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup". + */ + filters?: Schema$DimensionValue[]; + /** + * The kind of resource this is, in this case dfareporting#activities. + */ + kind?: string | null; + /** + * List of names of floodlight activity metrics. + */ + metricNames?: string[] | null; + } + /** + * Contains properties of a Campaign Manager ad. + */ + export interface Schema$Ad { + /** + * Account ID of this ad. This is a read-only field that can be left blank. + */ + accountId?: string | null; + /** + * Whether this ad is active. When true, archived must be false. + */ + active?: boolean | null; + /** + * Advertiser ID of this ad. This is a required field on insertion. + */ + advertiserId?: string | null; + /** + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Whether this ad is archived. When true, active must be false. + */ + archived?: boolean | null; + /** + * Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD. + */ + audienceSegmentId?: string | null; + /** + * Campaign ID of this ad. This is a required field on insertion. + */ + campaignId?: string | null; + /** + * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. + */ + campaignIdDimensionValue?: Schema$DimensionValue; + /** + * Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER. + */ + clickThroughUrl?: Schema$ClickThroughUrl; + /** + * Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative. + */ + clickThroughUrlSuffixProperties?: Schema$ClickThroughUrlSuffixProperties; + /** + * Comments for this ad. + */ + comments?: string | null; + /** + * Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard. + */ + compatibility?: string | null; + /** + * Information about the creation of this ad. This is a read-only field. + */ + createInfo?: Schema$LastModifiedInfo; + /** + * Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments. + */ + creativeGroupAssignments?: Schema$CreativeGroupAssignment[]; + /** + * Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment. + */ + creativeRotation?: Schema$CreativeRotation; + /** + * Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. + */ + dayPartTargeting?: Schema$DayPartTargeting; + /** + * Default click-through event tag properties for this ad. + */ + defaultClickThroughEventTagProperties?: Schema$DefaultClickThroughEventTagProperties; + /** + * Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD. + */ + deliverySchedule?: Schema$DeliverySchedule; + /** + * Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert. + */ + dynamicClickTracker?: boolean | null; + /** + * Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion. + */ + endTime?: string | null; + /** + * Event tag overrides for this ad. + */ + eventTagOverrides?: Schema$EventTagOverride[]; + /** + * Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. + */ + geoTargeting?: Schema$GeoTargeting; + /** + * ID of this ad. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Dimension value for the ID of this ad. This is a read-only, auto-generated field. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. + */ + keyValueTargetingExpression?: Schema$KeyValueTargetingExpression; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad". + */ + kind?: string | null; + /** + * Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. + */ + languageTargeting?: Schema$LanguageTargeting; + /** + * Information about the most recent modification of this ad. This is a read-only field. + */ + lastModifiedInfo?: Schema$LastModifiedInfo; + /** + * Name of this ad. This is a required field and must be less than 256 characters long. + */ + name?: string | null; + /** + * Placement assignments for this ad. + */ + placementAssignments?: Schema$PlacementAssignment[]; + /** + * Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. + */ + remarketingListExpression?: Schema$ListTargetingExpression; + /** + * Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. + */ + size?: Schema$Size; + /** + * Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated. + */ + sslCompliant?: boolean | null; + /** + * Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated. + */ + sslRequired?: boolean | null; + /** + * Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion. + */ + startTime?: string | null; + /** + * Subaccount ID of this ad. This is a read-only field that can be left blank. + */ + subaccountId?: string | null; + /** + * Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD. + */ + targetingTemplateId?: string | null; + /** + * Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. + */ + technologyTargeting?: Schema$TechnologyTargeting; + /** + * Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource). + */ + type?: string | null; + } + /** + * Campaign ad blocking settings. + */ + export interface Schema$AdBlockingConfiguration { + /** + * Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true. + */ + clickThroughUrl?: string | null; + /** + * ID of a creative bundle to use for this campaign. If set, brand-neutral ads will select creatives from this bundle. Otherwise, a default transparent pixel will be used. + */ + creativeBundleId?: string | null; + /** + * Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings. + */ + enabled?: boolean | null; + /** + * Whether the brand-neutral ad's click-through URL comes from the campaign's creative bundle or the override URL. Must be set to true if ad blocking is enabled and no creative bundle is configured. + */ + overrideClickThroughUrl?: boolean | null; + } + /** + * Ad List Response + */ + export interface Schema$AdsListResponse { + /** + * Ad collection. + */ + ads?: Schema$Ad[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#adsListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * Ad Slot + */ + export interface Schema$AdSlot { + /** + * Comment for this ad slot. + */ + comment?: string | null; + /** + * Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. + */ + compatibility?: string | null; + /** + * Height of this ad slot. + */ + height?: string | null; + /** + * ID of the placement from an external platform that is linked to this ad slot. + */ + linkedPlacementId?: string | null; + /** + * Name of this ad slot. + */ + name?: string | null; + /** + * Payment source type of this ad slot. + */ + paymentSourceType?: string | null; + /** + * Primary ad slot of a roadblock inventory item. + */ + primary?: boolean | null; + /** + * Width of this ad slot. + */ + width?: string | null; + } + /** + * Contains properties of a Campaign Manager advertiser. + */ + export interface Schema$Advertiser { + /** + * Account ID of this advertiser.This is a read-only field that can be left blank. + */ + accountId?: string | null; + /** + * ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group. + */ + advertiserGroupId?: string | null; + /** + * Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long. + */ + clickThroughUrlSuffix?: string | null; + /** + * ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns. + */ + defaultClickThroughEventTagId?: string | null; + /** + * Default email address used in sender field for tag emails. + */ + defaultEmail?: string | null; + /** + * Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. - This advertiser's original floodlight configuration is not already shared with another advertiser. + */ + floodlightConfigurationId?: string | null; + /** + * Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. + */ + floodlightConfigurationIdDimensionValue?: Schema$DimensionValue; + /** + * ID of this advertiser. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Dimension value for the ID of this advertiser. This is a read-only, auto-generated field. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser". + */ + kind?: string | null; + /** + * Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account. + */ + name?: string | null; + /** + * Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement. + */ + originalFloodlightConfigurationId?: string | null; + /** + * Status of this advertiser. + */ + status?: string | null; + /** + * Subaccount ID of this advertiser.This is a read-only field that can be left blank. + */ + subaccountId?: string | null; + /** + * Suspension status of this advertiser. + */ + suspended?: boolean | null; + } + /** + * Groups advertisers together so that reports can be generated for the entire group at once. + */ + export interface Schema$AdvertiserGroup { + /** + * Account ID of this advertiser group. This is a read-only field that can be left blank. + */ + accountId?: string | null; + /** + * ID of this advertiser group. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup". + */ + kind?: string | null; + /** + * Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account. + */ + name?: string | null; + } + /** + * Advertiser Group List Response + */ + export interface Schema$AdvertiserGroupsListResponse { + /** + * Advertiser group collection. + */ + advertiserGroups?: Schema$AdvertiserGroup[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroupsListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * Landing Page List Response + */ + export interface Schema$AdvertiserLandingPagesListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserLandingPagesListResponse". + */ + kind?: string | null; + /** + * Landing page collection + */ + landingPages?: Schema$LandingPage[]; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * Advertiser List Response + */ + export interface Schema$AdvertisersListResponse { + /** + * Advertiser collection. + */ + advertisers?: Schema$Advertiser[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertisersListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * Audience Segment. + */ + export interface Schema$AudienceSegment { + /** + * Weight allocated to this segment. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group. Acceptable values are 1 to 1000, inclusive. + */ + allocation?: number | null; + /** + * ID of this audience segment. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Name of this audience segment. This is a required field and must be less than 65 characters long. + */ + name?: string | null; + } + /** + * Audience Segment Group. + */ + export interface Schema$AudienceSegmentGroup { + /** + * Audience segments assigned to this group. The number of segments must be between 2 and 100. + */ + audienceSegments?: Schema$AudienceSegment[]; + /** + * ID of this audience segment group. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Name of this audience segment group. This is a required field and must be less than 65 characters long. + */ + name?: string | null; + } + /** + * Contains information about a browser that can be targeted by ads. + */ + export interface Schema$Browser { + /** + * ID referring to this grouping of browser and version numbers. This is the ID used for targeting. + */ + browserVersionId?: string | null; + /** + * DART ID of this browser. This is the ID used when generating reports. + */ + dartId?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser". + */ + kind?: string | null; + /** + * Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is. + */ + majorVersion?: string | null; + /** + * Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is. + */ + minorVersion?: string | null; + /** + * Name of this browser. + */ + name?: string | null; + } + /** + * Browser List Response + */ + export interface Schema$BrowsersListResponse { + /** + * Browser collection. + */ + browsers?: Schema$Browser[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#browsersListResponse". + */ + kind?: string | null; + } + /** + * Contains properties of a Campaign Manager campaign. + */ + export interface Schema$Campaign { + /** + * Account ID of this campaign. This is a read-only field that can be left blank. + */ + accountId?: string | null; + /** + * Ad blocking settings for this campaign. + */ + adBlockingConfiguration?: Schema$AdBlockingConfiguration; + /** + * Additional creative optimization configurations for the campaign. + */ + additionalCreativeOptimizationConfigurations?: Schema$CreativeOptimizationConfiguration[]; + /** + * Advertiser group ID of the associated advertiser. + */ + advertiserGroupId?: string | null; + /** + * Advertiser ID of this campaign. This is a required field. + */ + advertiserId?: string | null; + /** + * Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Whether this campaign has been archived. + */ + archived?: boolean | null; + /** + * Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups. + */ + audienceSegmentGroups?: Schema$AudienceSegmentGroup[]; + /** + * Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign. + */ + billingInvoiceCode?: string | null; + /** + * Click-through URL suffix override properties for this campaign. + */ + clickThroughUrlSuffixProperties?: Schema$ClickThroughUrlSuffixProperties; + /** + * Arbitrary comments about this campaign. Must be less than 256 characters long. + */ + comment?: string | null; + /** + * Information about the creation of this campaign. This is a read-only field. + */ + createInfo?: Schema$LastModifiedInfo; + /** + * List of creative group IDs that are assigned to the campaign. + */ + creativeGroupIds?: string[] | null; + /** + * Creative optimization configuration for the campaign. + */ + creativeOptimizationConfiguration?: Schema$CreativeOptimizationConfiguration; + /** + * Click-through event tag ID override properties for this campaign. + */ + defaultClickThroughEventTagProperties?: Schema$DefaultClickThroughEventTagProperties; + /** + * The default landing page ID for this campaign. + */ + defaultLandingPageId?: string | null; + /** + * Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field. + */ + endDate?: string | null; + /** + * Overrides that can be used to activate or deactivate advertiser event tags. + */ + eventTagOverrides?: Schema$EventTagOverride[]; + /** + * External ID for this campaign. + */ + externalId?: string | null; + /** + * ID of this campaign. This is a read-only auto-generated field. + */ + id?: string | null; + /** + * Dimension value for the ID of this campaign. This is a read-only, auto-generated field. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign". + */ + kind?: string | null; + /** + * Information about the most recent modification of this campaign. This is a read-only field. + */ + lastModifiedInfo?: Schema$LastModifiedInfo; + /** + * Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser. + */ + name?: string | null; + /** + * Whether Nielsen reports are enabled for this campaign. + */ + nielsenOcrEnabled?: boolean | null; + /** + * Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field. + */ + startDate?: string | null; + /** + * Subaccount ID of this campaign. This is a read-only field that can be left blank. + */ + subaccountId?: string | null; + /** + * Campaign trafficker contact emails. + */ + traffickerEmails?: string[] | null; + } + /** + * Identifies a creative which has been associated with a given campaign. + */ + export interface Schema$CampaignCreativeAssociation { + /** + * ID of the creative associated with the campaign. This is a required field. + */ + creativeId?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation". + */ + kind?: string | null; + } + /** + * Campaign Creative Association List Response + */ + export interface Schema$CampaignCreativeAssociationsListResponse { + /** + * Campaign creative association collection + */ + campaignCreativeAssociations?: Schema$CampaignCreativeAssociation[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociationsListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * Campaign List Response + */ + export interface Schema$CampaignsListResponse { + /** + * Campaign collection. + */ + campaigns?: Schema$Campaign[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignsListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * Describes a change that a user has made to a resource. + */ + export interface Schema$ChangeLog { + /** + * Account ID of the modified object. + */ + accountId?: string | null; + /** + * Action which caused the change. + */ + action?: string | null; + /** + * Time when the object was modified. + */ + changeTime?: string | null; + /** + * Field name of the object which changed. + */ + fieldName?: string | null; + /** + * ID of this change log. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLog". + */ + kind?: string | null; + /** + * New value of the object field. + */ + newValue?: string | null; + /** + * ID of the object of this change log. The object could be a campaign, placement, ad, or other type. + */ + objectId?: string | null; + /** + * Object type of the change log. + */ + objectType?: string | null; + /** + * Old value of the object field. + */ + oldValue?: string | null; + /** + * Subaccount ID of the modified object. + */ + subaccountId?: string | null; + /** + * Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId. + */ + transactionId?: string | null; + /** + * ID of the user who modified the object. + */ + userProfileId?: string | null; + /** + * User profile name of the user who modified the object. + */ + userProfileName?: string | null; + } + /** + * Change Log List Response + */ + export interface Schema$ChangeLogsListResponse { + /** + * Change log collection. + */ + changeLogs?: Schema$ChangeLog[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLogsListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * City List Response + */ + export interface Schema$CitiesListResponse { + /** + * City collection. + */ + cities?: Schema$City[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#citiesListResponse". + */ + kind?: string | null; + } + /** + * Contains information about a city that can be targeted by ads. + */ + export interface Schema$City { + /** + * Country code of the country to which this city belongs. + */ + countryCode?: string | null; + /** + * DART ID of the country to which this city belongs. + */ + countryDartId?: string | null; + /** + * DART ID of this city. This is the ID used for targeting and generating reports. + */ + dartId?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#city". + */ + kind?: string | null; + /** + * Metro region code of the metro region (DMA) to which this city belongs. + */ + metroCode?: string | null; + /** + * ID of the metro region (DMA) to which this city belongs. + */ + metroDmaId?: string | null; + /** + * Name of this city. + */ + name?: string | null; + /** + * Region code of the region to which this city belongs. + */ + regionCode?: string | null; + /** + * DART ID of the region to which this city belongs. + */ + regionDartId?: string | null; + } + /** + * Creative Click Tag. + */ + export interface Schema$ClickTag { + /** + * Parameter value for the specified click tag. This field contains a click-through url. + */ + clickThroughUrl?: Schema$CreativeClickThroughUrl; + /** + * Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + */ + eventName?: string | null; + /** + * Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field. + */ + name?: string | null; + } + /** + * Click-through URL + */ + export interface Schema$ClickThroughUrl { + /** + * Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. + */ + computedClickThroughUrl?: string | null; + /** + * Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. + */ + customClickThroughUrl?: string | null; + /** + * Whether the campaign default landing page is used. + */ + defaultLandingPage?: boolean | null; + /** + * ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. + */ + landingPageId?: string | null; + } + /** + * Click Through URL Suffix settings. + */ + export interface Schema$ClickThroughUrlSuffixProperties { + /** + * Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long. + */ + clickThroughUrlSuffix?: string | null; + /** + * Whether this entity should override the inherited click-through URL suffix with its own defined value. + */ + overrideInheritedSuffix?: boolean | null; + } + /** + * Companion Click-through override. + */ + export interface Schema$CompanionClickThroughOverride { + /** + * Click-through URL of this companion click-through override. + */ + clickThroughUrl?: Schema$ClickThroughUrl; + /** + * ID of the creative for this companion click-through override. + */ + creativeId?: string | null; + } + /** + * Companion Settings + */ + export interface Schema$CompanionSetting { + /** + * Whether companions are disabled for this placement. + */ + companionsDisabled?: boolean | null; + /** + * Whitelist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes. + */ + enabledSizes?: Schema$Size[]; + /** + * Whether to serve only static images as companions. + */ + imageOnly?: boolean | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting". + */ + kind?: string | null; + } + /** + * Represents a response to the queryCompatibleFields method. + */ + export interface Schema$CompatibleFields { + /** + * Contains items that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH". + */ + crossDimensionReachReportCompatibleFields?: Schema$CrossDimensionReachReportCompatibleFields; + /** + * Contains items that are compatible to be selected for a report of type "FLOODLIGHT". + */ + floodlightReportCompatibleFields?: Schema$FloodlightReportCompatibleFields; + /** + * The kind of resource this is, in this case dfareporting#compatibleFields. + */ + kind?: string | null; + /** + * Contains items that are compatible to be selected for a report of type "PATH_TO_CONVERSION". + */ + pathToConversionReportCompatibleFields?: Schema$PathToConversionReportCompatibleFields; + /** + * Contains items that are compatible to be selected for a report of type "REACH". + */ + reachReportCompatibleFields?: Schema$ReachReportCompatibleFields; + /** + * Contains items that are compatible to be selected for a report of type "STANDARD". + */ + reportCompatibleFields?: Schema$ReportCompatibleFields; + } + /** + * Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users. + */ + export interface Schema$ConnectionType { + /** + * ID of this connection type. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType". + */ + kind?: string | null; + /** + * Name of this connection type. + */ + name?: string | null; + } + /** + * Connection Type List Response + */ + export interface Schema$ConnectionTypesListResponse { + /** + * Collection of connection types such as broadband and mobile. + */ + connectionTypes?: Schema$ConnectionType[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionTypesListResponse". + */ + kind?: string | null; + } + /** + * Content Category List Response + */ + export interface Schema$ContentCategoriesListResponse { + /** + * Content category collection. + */ + contentCategories?: Schema$ContentCategory[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategoriesListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * Organizes placements according to the contents of their associated webpages. + */ + export interface Schema$ContentCategory { + /** + * Account ID of this content category. This is a read-only field that can be left blank. + */ + accountId?: string | null; + /** + * ID of this content category. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory". + */ + kind?: string | null; + /** + * Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account. + */ + name?: string | null; + } + /** + * A Conversion represents when a user successfully performs a desired action after seeing an ad. + */ + export interface Schema$Conversion { + /** + * Whether this particular request may come from a user under the age of 13, under COPPA compliance. + */ + childDirectedTreatment?: boolean | null; + /** + * Custom floodlight variables. + */ + customVariables?: Schema$CustomFloodlightVariable[]; + /** + * The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[], matchId, mobileDeviceId and gclid. This or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid is a required field. + */ + encryptedUserId?: string | null; + /** + * A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with INVALID_ARGUMENT error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId, matchId, mobileDeviceId and gclid. This or encryptedUserId or matchId or mobileDeviceId or gclid is a required field. + */ + encryptedUserIdCandidates?: string[] | null; + /** + * Floodlight Activity ID of this conversion. This is a required field. + */ + floodlightActivityId?: string | null; + /** + * Floodlight Configuration ID of this conversion. This is a required field. + */ + floodlightConfigurationId?: string | null; + /** + * The Google click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId and mobileDeviceId. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId is a required field. + */ + gclid?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion". + */ + kind?: string | null; + /** + * Whether Limit Ad Tracking is enabled. When set to true, the conversion will be used for reporting but not targeting. This will prevent remarketing. + */ + limitAdTracking?: boolean | null; + /** + * The match ID field. A match ID is your own first-party identifier that has been synced with Google using the match ID feature in Floodlight. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[],mobileDeviceId and gclid. This or encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId or gclid is a required field. + */ + matchId?: string | null; + /** + * The mobile device ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId and gclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or gclid is a required field. + */ + mobileDeviceId?: string | null; + /** + * Whether the conversion was for a non personalized ad. + */ + nonPersonalizedAd?: boolean | null; + /** + * The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field. + */ + ordinal?: string | null; + /** + * The quantity of the conversion. + */ + quantity?: string | null; + /** + * The timestamp of conversion, in Unix epoch micros. This is a required field. + */ + timestampMicros?: string | null; + /** + * Whether this particular request may come from a user under the age of 16 (may differ by country), under compliance with the European Union's General Data Protection Regulation (GDPR). + */ + treatmentForUnderage?: boolean | null; + /** + * The value of the conversion. + */ + value?: number | null; + } + /** + * The error code and description for a conversion that failed to insert or update. + */ + export interface Schema$ConversionError { + /** + * The error code. + */ + code?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionError". + */ + kind?: string | null; + /** + * A description of the error. + */ + message?: string | null; + } + /** + * Insert Conversions Request. + */ + export interface Schema$ConversionsBatchInsertRequest { + /** + * The set of conversions to insert. + */ + conversions?: Schema$Conversion[]; + /** + * Describes how encryptedUserId or encryptedUserIdCandidates[] is encrypted. This is a required field if encryptedUserId or encryptedUserIdCandidates[] is used. + */ + encryptionInfo?: Schema$EncryptionInfo; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertRequest". + */ + kind?: string | null; + } + /** + * Insert Conversions Response. + */ + export interface Schema$ConversionsBatchInsertResponse { + /** + * Indicates that some or all conversions failed to insert. + */ + hasFailures?: boolean | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertResponse". + */ + kind?: string | null; + /** + * The insert status of each conversion. Statuses are returned in the same order that conversions are inserted. + */ + status?: Schema$ConversionStatus[]; + } + /** + * Update Conversions Request. + */ + export interface Schema$ConversionsBatchUpdateRequest { + /** + * The set of conversions to update. + */ + conversions?: Schema$Conversion[]; + /** + * Describes how encryptedUserId is encrypted. This is a required field if encryptedUserId is used. + */ + encryptionInfo?: Schema$EncryptionInfo; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchUpdateRequest". + */ + kind?: string | null; + } + /** + * Update Conversions Response. + */ + export interface Schema$ConversionsBatchUpdateResponse { + /** + * Indicates that some or all conversions failed to update. + */ + hasFailures?: boolean | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchUpdateResponse". + */ + kind?: string | null; + /** + * The update status of each conversion. Statuses are returned in the same order that conversions are updated. + */ + status?: Schema$ConversionStatus[]; + } + /** + * The original conversion that was inserted or updated and whether there were any errors. + */ + export interface Schema$ConversionStatus { + /** + * The original conversion that was inserted or updated. + */ + conversion?: Schema$Conversion; + /** + * A list of errors related to this conversion. + */ + errors?: Schema$ConversionError[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionStatus". + */ + kind?: string | null; + } + /** + * Country List Response + */ + export interface Schema$CountriesListResponse { + /** + * Country collection. + */ + countries?: Schema$Country[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#countriesListResponse". + */ + kind?: string | null; + } + /** + * Contains information about a country that can be targeted by ads. + */ + export interface Schema$Country { + /** + * Country code. + */ + countryCode?: string | null; + /** + * DART ID of this country. This is the ID used for targeting and generating reports. + */ + dartId?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#country". + */ + kind?: string | null; + /** + * Name of this country. + */ + name?: string | null; + /** + * Whether ad serving supports secure servers in this country. + */ + sslEnabled?: boolean | null; + } + /** + * Contains properties of a Creative. + */ + export interface Schema$Creative { + /** + * Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types. + */ + accountId?: string | null; + /** + * Whether the creative is active. Applicable to all creative types. + */ + active?: boolean | null; + /** + * Additional sizes associated with a responsive creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. Applicable to DISPLAY creatives when the primary asset type is HTML_IMAGE. + */ + additionalSizes?: Schema$Size[]; + /** + * Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID. + */ + adParameters?: string | null; + /** + * Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. + */ + adTagKeys?: string[] | null; + /** + * Advertiser ID of this creative. This is a required field. Applicable to all creative types. + */ + advertiserId?: string | null; + /** + * Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE. + */ + allowScriptAccess?: boolean | null; + /** + * Whether the creative is archived. Applicable to all creative types. + */ + archived?: boolean | null; + /** + * Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. + */ + artworkType?: string | null; + /** + * Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types. + */ + authoringSource?: string | null; + /** + * Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER. + */ + authoringTool?: string | null; + /** + * Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY. + */ + autoAdvanceImages?: boolean | null; + /** + * The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE. + */ + backgroundColor?: string | null; + /** + * Click-through URL for backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE. + */ + backupImageClickThroughUrl?: Schema$CreativeClickThroughUrl; + /** + * List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by Campaign Manager for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + */ + backupImageFeatures?: string[] | null; + /** + * Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE. + */ + backupImageReportingLabel?: string | null; + /** + * Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + */ + backupImageTargetWindow?: Schema$TargetWindow; + /** + * Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + */ + clickTags?: Schema$ClickTag[]; + /** + * Industry standard ID assigned to creative for reach and frequency. Applicable to INSTREAM_VIDEO_REDIRECT creatives. + */ + commercialId?: string | null; + /** + * List of companion creatives assigned to an in-Stream video creative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID, all INSTREAM_AUDIO and all INSTREAM_VIDEO with dynamicAssetSelection set to false. + */ + companionCreatives?: string[] | null; + /** + * Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. IN_STREAM_AUDIO refers to rendering in in-stream audio ads developed with the VAST standard. Applicable to all creative types. Acceptable values are: - "APP" - "APP_INTERSTITIAL" - "IN_STREAM_VIDEO" - "IN_STREAM_AUDIO" - "DISPLAY" - "DISPLAY_INTERSTITIAL" + */ + compatibility?: string[] | null; + /** + * Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + */ + convertFlashToHtml5?: boolean | null; + /** + * List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. + */ + counterCustomEvents?: Schema$CreativeCustomEvent[]; + /** + * Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT + */ + creativeAssets?: Schema$CreativeAsset[]; + /** + * Required if dynamicAssetSelection is true. + */ + creativeAssetSelection?: Schema$CreativeAssetSelection; + /** + * Creative field assignments for this creative. Applicable to all creative types. + */ + creativeFieldAssignments?: Schema$CreativeFieldAssignment[]; + /** + * Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. + */ + customKeyValues?: string[] | null; + /** + * Set this to true to enable the use of rules to target individual assets in this creative. When set to true creativeAssetSelection must be set. This also controls asset-level companions. When this is true, companion creatives should be assigned to creative assets. Learn more. Applicable to INSTREAM_VIDEO creatives. + */ + dynamicAssetSelection?: boolean | null; + /** + * List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + */ + exitCustomEvents?: Schema$CreativeCustomEvent[]; + /** + * OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE. + */ + fsCommand?: Schema$FsCommand; + /** + * HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is true. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA. + */ + htmlCode?: string | null; + /** + * Whether HTML code is generated by Campaign Manager or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. + */ + htmlCodeLocked?: boolean | null; + /** + * ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types. + */ + id?: string | null; + /** + * Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative". + */ + kind?: string | null; + /** + * Creative last modification information. This is a read-only field. Applicable to all creative types. + */ + lastModifiedInfo?: Schema$LastModifiedInfo; + /** + * Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. + */ + latestTraffickedCreativeId?: string | null; + /** + * Description of the audio or video ad. Applicable to the following creative types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID. + */ + mediaDescription?: string | null; + /** + * Creative audio or video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, INSTREAM_AUDIO, all RICH_MEDIA, and all VPAID. + */ + mediaDuration?: number | null; + /** + * Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types. + */ + name?: string | null; + /** + * Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA. + */ + overrideCss?: string | null; + /** + * Amount of time to play the video before counting a view. Applicable to the following creative types: all INSTREAM_VIDEO. + */ + progressOffset?: Schema$VideoOffset; + /** + * URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT + */ + redirectUrl?: string | null; + /** + * ID of current rendering version. This is a read-only field. Applicable to all creative types. + */ + renderingId?: string | null; + /** + * Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types. + */ + renderingIdDimensionValue?: Schema$DimensionValue; + /** + * The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. + */ + requiredFlashPluginVersion?: string | null; + /** + * The internal Flash version for this creative as calculated by Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + */ + requiredFlashVersion?: number | null; + /** + * Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. + */ + size?: Schema$Size; + /** + * Amount of time to play the video before the skip button appears. Applicable to the following creative types: all INSTREAM_VIDEO. + */ + skipOffset?: Schema$VideoOffset; + /** + * Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID. + */ + skippable?: boolean | null; + /** + * Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types. + */ + sslCompliant?: boolean | null; + /** + * Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types. + */ + sslOverride?: boolean | null; + /** + * Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. + */ + studioAdvertiserId?: string | null; + /** + * Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. + */ + studioCreativeId?: string | null; + /** + * Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. + */ + studioTraffickedCreativeId?: string | null; + /** + * Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types. + */ + subaccountId?: string | null; + /** + * Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA. + */ + thirdPartyBackupImageImpressionsUrl?: string | null; + /** + * Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA. + */ + thirdPartyRichMediaImpressionsUrl?: string | null; + /** + * Third-party URLs for tracking in-stream creative events. Applicable to the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and all VPAID. + */ + thirdPartyUrls?: Schema$ThirdPartyTrackingUrl[]; + /** + * List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE. + */ + timerCustomEvents?: Schema$CreativeCustomEvent[]; + /** + * Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. + */ + totalFileSize?: string | null; + /** + * Type of this creative. This is a required field. Applicable to all creative types. Note: FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing creatives. New creatives should use DISPLAY as a replacement for these types. + */ + type?: string | null; + /** + * A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO and INSTREAM_VIDEO and VPAID. + */ + universalAdId?: Schema$UniversalAdId; + /** + * The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types. + */ + version?: number | null; + } + /** + * Creative Asset. + */ + export interface Schema$CreativeAsset { + /** + * Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + */ + actionScript3?: boolean | null; + /** + * Whether the video or audio asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. + */ + active?: boolean | null; + /** + * Additional sizes associated with this creative asset. HTML5 asset generated by compatible software such as GWD will be able to support more sizes this creative asset can render. + */ + additionalSizes?: Schema$Size[]; + /** + * Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL. + */ + alignment?: string | null; + /** + * Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. + */ + artworkType?: string | null; + /** + * Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. + */ + assetIdentifier?: Schema$CreativeAssetId; + /** + * Audio stream bit rate in kbps. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. + */ + audioBitRate?: number | null; + /** + * Audio sample bit rate in hertz. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. + */ + audioSampleRate?: number | null; + /** + * Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA. + */ + backupImageExit?: Schema$CreativeCustomEvent; + /** + * Detected bit-rate for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. + */ + bitRate?: number | null; + /** + * Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID. + */ + childAssetType?: string | null; + /** + * Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN. + */ + collapsedSize?: Schema$Size; + /** + * List of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to true. + */ + companionCreativeIds?: string[] | null; + /** + * Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA. Value must be greater than or equal to 0. + */ + customStartTimeValue?: number | null; + /** + * List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + */ + detectedFeatures?: string[] | null; + /** + * Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. + */ + displayType?: string | null; + /** + * Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID_LINEAR_VIDEO. Value must be greater than or equal to 1. + */ + duration?: number | null; + /** + * Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA. + */ + durationType?: string | null; + /** + * Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. + */ + expandedDimension?: Schema$Size; + /** + * File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. + */ + fileSize?: string | null; + /** + * Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + */ + flashVersion?: number | null; + /** + * Video frame rate for video asset in frames per second. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. + */ + frameRate?: number | null; + /** + * Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA. + */ + hideFlashObjects?: boolean | null; + /** + * Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA. + */ + hideSelectionBoxes?: boolean | null; + /** + * Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. + */ + horizontallyLocked?: boolean | null; + /** + * Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. + */ + id?: string | null; + /** + * Dimension value for the ID of the asset. This is a read-only, auto-generated field. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Detected duration for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. + */ + mediaDuration?: number | null; + /** + * Detected MIME type for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. + */ + mimeType?: string | null; + /** + * Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN. + */ + offset?: Schema$OffsetPosition; + /** + * Orientation of video asset. This is a read-only, auto-generated field. + */ + orientation?: string | null; + /** + * Whether the backup asset is original or changed by the user in Campaign Manager. Applicable to the following creative types: all RICH_MEDIA. + */ + originalBackup?: boolean | null; + /** + * Whether this asset is used as a polite load asset. + */ + politeLoad?: boolean | null; + /** + * Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA. + */ + position?: Schema$OffsetPosition; + /** + * Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. + */ + positionLeftUnit?: string | null; + /** + * Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA. + */ + positionTopUnit?: string | null; + /** + * Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. + */ + progressiveServingUrl?: string | null; + /** + * Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height. + */ + pushdown?: boolean | null; + /** + * Pushdown duration in seconds for an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height. Acceptable values are 0 to 9.99, inclusive. + */ + pushdownDuration?: number | null; + /** + * Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field. PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives. BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. OTHER refers to assets from sources other than Campaign Manager, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives. PARENT_VIDEO refers to videos uploaded by the user in Campaign Manager and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. TRANSCODED_VIDEO refers to videos transcoded by Campaign Manager from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. ALTERNATE_VIDEO refers to the Campaign Manager representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within Campaign Manager. For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative. PARENT_AUDIO refers to audios uploaded by the user in Campaign Manager and is applicable to INSTREAM_AUDIO creatives. TRANSCODED_AUDIO refers to audios transcoded by Campaign Manager from PARENT_AUDIO assets and is applicable to INSTREAM_AUDIO creatives. + */ + role?: string | null; + /** + * Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + */ + size?: Schema$Size; + /** + * Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. + */ + sslCompliant?: boolean | null; + /** + * Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA. + */ + startTimeType?: string | null; + /** + * Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. + */ + streamingServingUrl?: string | null; + /** + * Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets. + */ + transparency?: boolean | null; + /** + * Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. + */ + verticallyLocked?: boolean | null; + /** + * Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING. + */ + windowMode?: string | null; + /** + * zIndex value of an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to 999999999, inclusive. + */ + zIndex?: number | null; + /** + * File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER. + */ + zipFilename?: string | null; + /** + * Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER. + */ + zipFilesize?: string | null; + } + /** + * Creative Asset ID. + */ + export interface Schema$CreativeAssetId { + /** + * Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed. + */ + name?: string | null; + /** + * Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE. + */ + type?: string | null; + } + /** + * CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative. + */ + export interface Schema$CreativeAssetMetadata { + /** + * ID of the creative asset. This is a required field. + */ + assetIdentifier?: Schema$CreativeAssetId; + /** + * List of detected click tags for assets. This is a read-only auto-generated field. + */ + clickTags?: Schema$ClickTag[]; + /** + * List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. + */ + detectedFeatures?: string[] | null; + /** + * Numeric ID of the asset. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Dimension value for the numeric ID of the asset. This is a read-only, auto-generated field. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata". + */ + kind?: string | null; + /** + * Rules validated during code generation that generated a warning. This is a read-only, auto-generated field. Possible values are: - "ADMOB_REFERENCED" - "ASSET_FORMAT_UNSUPPORTED_DCM" - "ASSET_INVALID" - "CLICK_TAG_HARD_CODED" - "CLICK_TAG_INVALID" - "CLICK_TAG_IN_GWD" - "CLICK_TAG_MISSING" - "CLICK_TAG_MORE_THAN_ONE" - "CLICK_TAG_NON_TOP_LEVEL" - "COMPONENT_UNSUPPORTED_DCM" - "ENABLER_UNSUPPORTED_METHOD_DCM" - "EXTERNAL_FILE_REFERENCED" - "FILE_DETAIL_EMPTY" - "FILE_TYPE_INVALID" - "GWD_PROPERTIES_INVALID" - "HTML5_FEATURE_UNSUPPORTED" - "LINKED_FILE_NOT_FOUND" - "MAX_FLASH_VERSION_11" - "MRAID_REFERENCED" - "NOT_SSL_COMPLIANT" - "ORPHANED_ASSET" - "PRIMARY_HTML_MISSING" - "SVG_INVALID" - "ZIP_INVALID" + */ + warnedValidationRules?: string[] | null; + } + /** + * Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. Applicable to INSTREAM_VIDEO creatives. + */ + export interface Schema$CreativeAssetSelection { + /** + * A creativeAssets[].id. This should refer to one of the parent assets in this creative, and will be served if none of the rules match. This is a required field. + */ + defaultAssetId?: string | null; + /** + * Rules determine which asset will be served to a viewer. Rules will be evaluated in the order in which they are stored in this list. This list must contain at least one rule. Applicable to INSTREAM_VIDEO creatives. + */ + rules?: Schema$Rule[]; + } + /** + * Creative Assignment. + */ + export interface Schema$CreativeAssignment { + /** + * Whether this creative assignment is active. When true, the creative will be included in the ad's rotation. + */ + active?: boolean | null; + /** + * Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO. + */ + applyEventTags?: boolean | null; + /** + * Click-through URL of the creative assignment. + */ + clickThroughUrl?: Schema$ClickThroughUrl; + /** + * Companion creative overrides for this creative assignment. Applicable to video ads. + */ + companionCreativeOverrides?: Schema$CompanionClickThroughOverride[]; + /** + * Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments. + */ + creativeGroupAssignments?: Schema$CreativeGroupAssignment[]; + /** + * ID of the creative to be assigned. This is a required field. + */ + creativeId?: string | null; + /** + * Dimension value for the ID of the creative. This is a read-only, auto-generated field. + */ + creativeIdDimensionValue?: Schema$DimensionValue; + /** + * Date and time that the assigned creative should stop serving. Must be later than the start time. + */ + endTime?: string | null; + /** + * Rich media exit overrides for this creative assignment. Applicable when the creative type is any of the following: - DISPLAY - RICH_MEDIA_INPAGE - RICH_MEDIA_INPAGE_FLOATING - RICH_MEDIA_IM_EXPAND - RICH_MEDIA_EXPANDING - RICH_MEDIA_INTERSTITIAL_FLOAT - RICH_MEDIA_MOBILE_IN_APP - RICH_MEDIA_MULTI_FLOATING - RICH_MEDIA_PEEL_DOWN - VPAID_LINEAR - VPAID_NON_LINEAR + */ + richMediaExitOverrides?: Schema$RichMediaExitOverride[]; + /** + * Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive. + */ + sequence?: number | null; + /** + * Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated. + */ + sslCompliant?: boolean | null; + /** + * Date and time that the assigned creative should start serving. + */ + startTime?: string | null; + /** + * Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1. + */ + weight?: number | null; + } + /** + * Click-through URL + */ + export interface Schema$CreativeClickThroughUrl { + /** + * Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field. + */ + computedClickThroughUrl?: string | null; + /** + * Custom click-through URL. Applicable if the landingPageId field is left unset. + */ + customClickThroughUrl?: string | null; + /** + * ID of the landing page for the click-through URL. + */ + landingPageId?: string | null; + } + /** + * Creative Custom Event. + */ + export interface Schema$CreativeCustomEvent { + /** + * Unique ID of this event used by Reporting and Data Transfer. This is a read-only field. + */ + advertiserCustomEventId?: string | null; + /** + * User-entered name for the event. + */ + advertiserCustomEventName?: string | null; + /** + * Type of the event. This is a read-only field. + */ + advertiserCustomEventType?: string | null; + /** + * Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion. + */ + artworkLabel?: string | null; + /** + * Artwork type used by the creative.This is a read-only field. + */ + artworkType?: string | null; + /** + * Exit click-through URL for the event. This field is used only for exit events. + */ + exitClickThroughUrl?: Schema$CreativeClickThroughUrl; + /** + * ID of this event. This is a required field and should not be modified after insertion. + */ + id?: string | null; + /** + * Properties for rich media popup windows. This field is used only for exit events. + */ + popupWindowProperties?: Schema$PopupWindowProperties; + /** + * Target type used by the event. + */ + targetType?: string | null; + /** + * Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field. + */ + videoReportingId?: string | null; + } + /** + * Contains properties of a creative field. + */ + export interface Schema$CreativeField { + /** + * Account ID of this creative field. This is a read-only field that can be left blank. + */ + accountId?: string | null; + /** + * Advertiser ID of this creative field. This is a required field on insertion. + */ + advertiserId?: string | null; + /** + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * ID of this creative field. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField". + */ + kind?: string | null; + /** + * Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser. + */ + name?: string | null; + /** + * Subaccount ID of this creative field. This is a read-only field that can be left blank. + */ + subaccountId?: string | null; + } + /** + * Creative Field Assignment. + */ + export interface Schema$CreativeFieldAssignment { + /** + * ID of the creative field. + */ + creativeFieldId?: string | null; + /** + * ID of the creative field value. + */ + creativeFieldValueId?: string | null; + } + /** + * Creative Field List Response + */ + export interface Schema$CreativeFieldsListResponse { + /** + * Creative field collection. + */ + creativeFields?: Schema$CreativeField[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldsListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * Contains properties of a creative field value. + */ + export interface Schema$CreativeFieldValue { + /** + * ID of this creative field value. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue". + */ + kind?: string | null; + /** + * Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field. + */ + value?: string | null; + } + /** + * Creative Field Value List Response + */ + export interface Schema$CreativeFieldValuesListResponse { + /** + * Creative field value collection. + */ + creativeFieldValues?: Schema$CreativeFieldValue[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValuesListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * Contains properties of a creative group. + */ + export interface Schema$CreativeGroup { + /** + * Account ID of this creative group. This is a read-only field that can be left blank. + */ + accountId?: string | null; + /** + * Advertiser ID of this creative group. This is a required field on insertion. + */ + advertiserId?: string | null; + /** + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive. + */ + groupNumber?: number | null; + /** + * ID of this creative group. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup". + */ + kind?: string | null; + /** + * Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser. + */ + name?: string | null; + /** + * Subaccount ID of this creative group. This is a read-only field that can be left blank. + */ + subaccountId?: string | null; + } + /** + * Creative Group Assignment. + */ + export interface Schema$CreativeGroupAssignment { + /** + * ID of the creative group to be assigned. + */ + creativeGroupId?: string | null; + /** + * Creative group number of the creative group assignment. + */ + creativeGroupNumber?: string | null; + } + /** + * Creative Group List Response + */ + export interface Schema$CreativeGroupsListResponse { + /** + * Creative group collection. + */ + creativeGroups?: Schema$CreativeGroup[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroupsListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * Creative optimization settings. + */ + export interface Schema$CreativeOptimizationConfiguration { + /** + * ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns. + */ + id?: string | null; + /** + * Name of this creative optimization config. This is a required field and must be less than 129 characters long. + */ + name?: string | null; + /** + * List of optimization activities associated with this configuration. + */ + optimizationActivitys?: Schema$OptimizationActivity[]; + /** + * Optimization model for this configuration. + */ + optimizationModel?: string | null; + } + /** + * Creative Rotation. + */ + export interface Schema$CreativeRotation { + /** + * Creative assignments in this creative rotation. + */ + creativeAssignments?: Schema$CreativeAssignment[]; + /** + * Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad. + */ + creativeOptimizationConfigurationId?: string | null; + /** + * Type of creative rotation. Can be used to specify whether to use sequential or random rotation. + */ + type?: string | null; + /** + * Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM. + */ + weightCalculationStrategy?: string | null; + } + /** + * Creative List Response + */ + export interface Schema$CreativesListResponse { + /** + * Creative collection. + */ + creatives?: Schema$Creative[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativesListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * Represents fields that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH". + */ + export interface Schema$CrossDimensionReachReportCompatibleFields { + /** + * Dimensions which are compatible to be selected in the "breakdown" section of the report. + */ + breakdown?: Schema$Dimension[]; + /** + * Dimensions which are compatible to be selected in the "dimensionFilters" section of the report. + */ + dimensionFilters?: Schema$Dimension[]; + /** + * The kind of resource this is, in this case dfareporting#crossDimensionReachReportCompatibleFields. + */ + kind?: string | null; + /** + * Metrics which are compatible to be selected in the "metricNames" section of the report. + */ + metrics?: Schema$Metric[]; + /** + * Metrics which are compatible to be selected in the "overlapMetricNames" section of the report. + */ + overlapMetrics?: Schema$Metric[]; + } + /** + * A custom floodlight variable. + */ + export interface Schema$CustomFloodlightVariable { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable". + */ + kind?: string | null; + /** + * The type of custom floodlight variable to supply a value for. These map to the "u[1-20]=" in the tags. + */ + type?: string | null; + /** + * The value of the custom floodlight variable. The length of string must not exceed 50 characters. + */ + value?: string | null; + } + /** + * Represents a Custom Rich Media Events group. + */ + export interface Schema$CustomRichMediaEvents { + /** + * List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName. + */ + filteredEventIds?: Schema$DimensionValue[]; + /** + * The kind of resource this is, in this case dfareporting#customRichMediaEvents. + */ + kind?: string | null; + } + /** + * Custom Viewability Metric + */ + export interface Schema$CustomViewabilityMetric { + /** + * Configuration of the custom viewability metric. + */ + configuration?: Schema$CustomViewabilityMetricConfiguration; + /** + * ID of the custom viewability metric. + */ + id?: string | null; + /** + * Name of the custom viewability metric. + */ + name?: string | null; + } + /** + * The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric. + */ + export interface Schema$CustomViewabilityMetricConfiguration { + /** + * Whether the video must be audible to count an impression. + */ + audible?: boolean | null; + /** + * The time in milliseconds the video must play for the Custom Viewability Metric to count an impression. If both this and timePercent are specified, the earlier of the two will be used. + */ + timeMillis?: number | null; + /** + * The percentage of video that must play for the Custom Viewability Metric to count an impression. If both this and timeMillis are specified, the earlier of the two will be used. + */ + timePercent?: number | null; + /** + * The percentage of video that must be on screen for the Custom Viewability Metric to count an impression. + */ + viewabilityPercent?: number | null; + } + /** + * Represents a date range. + */ + export interface Schema$DateRange { + /** + * The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd". + */ + endDate?: string | null; + /** + * The kind of resource this is, in this case dfareporting#dateRange. + */ + kind?: string | null; + /** + * The date range relative to the date of when the report is run. + */ + relativeDateRange?: string | null; + /** + * The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd". + */ + startDate?: string | null; + } + /** + * Day Part Targeting. + */ + export interface Schema$DayPartTargeting { + /** + * Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY" + */ + daysOfWeek?: string[] | null; + /** + * Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive. + */ + hoursOfDay?: number[] | null; + /** + * Whether or not to use the user's local time. If false, the America/New York time zone applies. + */ + userLocalTime?: boolean | null; + } + /** + * Contains information about a landing page deep link. + */ + export interface Schema$DeepLink { + /** + * The URL of the mobile app being linked to. + */ + appUrl?: string | null; + /** + * The fallback URL. This URL will be served to users who do not have the mobile app installed. + */ + fallbackUrl?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink". + */ + kind?: string | null; + /** + * The mobile app targeted by this deep link. + */ + mobileApp?: Schema$MobileApp; + /** + * Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE. + */ + remarketingListIds?: string[] | null; + } + /** + * Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. + */ + export interface Schema$DefaultClickThroughEventTagProperties { + /** + * ID of the click-through event tag to apply to all ads in this entity's scope. + */ + defaultClickThroughEventTagId?: string | null; + /** + * Whether this entity should override the inherited default click-through event tag with its own defined value. + */ + overrideInheritedEventTag?: boolean | null; + } + /** + * Delivery Schedule. + */ + export interface Schema$DeliverySchedule { + /** + * Limit on the number of times an individual user can be served the ad within a specified period of time. + */ + frequencyCap?: Schema$FrequencyCap; + /** + * Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals. + */ + hardCutoff?: boolean | null; + /** + * Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager will serve ad B three times as often as ad A. Acceptable values are 1 to 10, inclusive. + */ + impressionRatio?: string | null; + /** + * Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served. + */ + priority?: string | null; + } + /** + * Google Ad Manager Settings + */ + export interface Schema$DfpSettings { + /** + * Ad Manager network code for this directory site. + */ + dfpNetworkCode?: string | null; + /** + * Ad Manager network name for this directory site. + */ + dfpNetworkName?: string | null; + /** + * Whether this directory site accepts programmatic placements. + */ + programmaticPlacementAccepted?: boolean | null; + /** + * Whether this directory site is available only via Publisher Portal. + */ + publisherPortalOnly?: boolean | null; + /** + * Whether this directory site accepts publisher-paid tags. + */ + pubPaidPlacementAccepted?: boolean | null; + } + /** + * Represents a dimension. + */ + export interface Schema$Dimension { + /** + * The kind of resource this is, in this case dfareporting#dimension. + */ + kind?: string | null; + /** + * The dimension name, e.g. dfa:advertiser + */ + name?: string | null; + } + /** + * Represents a dimension filter. + */ + export interface Schema$DimensionFilter { + /** + * The name of the dimension to filter. + */ + dimensionName?: string | null; + /** + * The kind of resource this is, in this case dfareporting#dimensionFilter. + */ + kind?: string | null; + /** + * The value of the dimension to filter. + */ + value?: string | null; + } + /** + * Represents a DimensionValue resource. + */ + export interface Schema$DimensionValue { + /** + * The name of the dimension. + */ + dimensionName?: string | null; + /** + * The eTag of this response for caching purposes. + */ + etag?: string | null; + /** + * The ID associated with the value if available. + */ + id?: string | null; + /** + * The kind of resource this is, in this case dfareporting#dimensionValue. + */ + kind?: string | null; + /** + * Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. + */ + matchType?: string | null; + /** + * The value of the dimension. + */ + value?: string | null; + } + /** + * Represents the list of DimensionValue resources. + */ + export interface Schema$DimensionValueList { + /** + * The eTag of this response for caching purposes. + */ + etag?: string | null; + /** + * The dimension values returned in this response. + */ + items?: Schema$DimensionValue[]; + /** + * The kind of list this is, in this case dfareporting#dimensionValueList. + */ + kind?: string | null; + /** + * Continuation token used to page through dimension values. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted. + */ + nextPageToken?: string | null; + } + /** + * Represents a DimensionValuesRequest. + */ + export interface Schema$DimensionValueRequest { + /** + * The name of the dimension for which values should be requested. + */ + dimensionName?: string | null; + /** + * The end date of the date range for which to retrieve dimension values. A string of the format "yyyy-MM-dd". + */ + endDate?: string | null; + /** + * The list of filters by which to filter values. The filters are ANDed. + */ + filters?: Schema$DimensionFilter[]; + /** + * The kind of request this is, in this case dfareporting#dimensionValueRequest. + */ + kind?: string | null; + /** + * The start date of the date range for which to retrieve dimension values. A string of the format "yyyy-MM-dd". + */ + startDate?: string | null; + } + /** + * DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement. + */ + export interface Schema$DirectorySite { + /** + * Whether this directory site is active. + */ + active?: boolean | null; + /** + * ID of this directory site. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Dimension value for the ID of this directory site. This is a read-only, auto-generated field. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Tag types for regular placements. Acceptable values are: - "STANDARD" - "IFRAME_JAVASCRIPT_INPAGE" - "INTERNAL_REDIRECT_INPAGE" - "JAVASCRIPT_INPAGE" + */ + inpageTagFormats?: string[] | null; + /** + * Tag types for interstitial placements. Acceptable values are: - "IFRAME_JAVASCRIPT_INTERSTITIAL" - "INTERNAL_REDIRECT_INTERSTITIAL" - "JAVASCRIPT_INTERSTITIAL" + */ + interstitialTagFormats?: string[] | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite". + */ + kind?: string | null; + /** + * Name of this directory site. + */ + name?: string | null; + /** + * Directory site settings. + */ + settings?: Schema$DirectorySiteSettings; + /** + * URL of this directory site. + */ + url?: string | null; + } + /** + * Directory Site Settings + */ + export interface Schema$DirectorySiteSettings { + /** + * Whether this directory site has disabled active view creatives. + */ + activeViewOptOut?: boolean | null; + /** + * Directory site Ad Manager settings. + */ + dfpSettings?: Schema$DfpSettings; + /** + * Whether this site accepts in-stream video ads. + */ + instreamVideoPlacementAccepted?: boolean | null; + /** + * Whether this site accepts interstitial ads. + */ + interstitialPlacementAccepted?: boolean | null; + } + /** + * Directory Site List Response + */ + export interface Schema$DirectorySitesListResponse { + /** + * Directory site collection. + */ + directorySites?: Schema$DirectorySite[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySitesListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with Studio dynamic creatives. Use these labels instead of numeric Campaign Manager IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds. + */ + export interface Schema$DynamicTargetingKey { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKey". + */ + kind?: string | null; + /** + * Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase. + */ + name?: string | null; + /** + * ID of the object of this dynamic targeting key. This is a required field. + */ + objectId?: string | null; + /** + * Type of the object of this dynamic targeting key. This is a required field. + */ + objectType?: string | null; + } + /** + * Dynamic Targeting Key List Response + */ + export interface Schema$DynamicTargetingKeysListResponse { + /** + * Dynamic targeting key collection. + */ + dynamicTargetingKeys?: Schema$DynamicTargetingKey[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKeysListResponse". + */ + kind?: string | null; + } + /** + * A description of how user IDs are encrypted. + */ + export interface Schema$EncryptionInfo { + /** + * The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer. + */ + encryptionEntityId?: string | null; + /** + * The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer. + */ + encryptionEntityType?: string | null; + /** + * Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer. + */ + encryptionSource?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#encryptionInfo". + */ + kind?: string | null; + } + /** + * Contains properties of an event tag. + */ + export interface Schema$EventTag { + /** + * Account ID of this event tag. This is a read-only field that can be left blank. + */ + accountId?: string | null; + /** + * Advertiser ID of this event tag. This field or the campaignId field is required on insertion. + */ + advertiserId?: string | null; + /** + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Campaign ID of this event tag. This field or the advertiserId field is required on insertion. + */ + campaignId?: string | null; + /** + * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. + */ + campaignIdDimensionValue?: Schema$DimensionValue; + /** + * Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads. + */ + enabledByDefault?: boolean | null; + /** + * Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network. + */ + excludeFromAdxRequests?: boolean | null; + /** + * ID of this event tag. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag". + */ + kind?: string | null; + /** + * Name of this event tag. This is a required field and must be less than 256 characters long. + */ + name?: string | null; + /** + * Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites. + */ + siteFilterType?: string | null; + /** + * Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter. + */ + siteIds?: string[] | null; + /** + * Whether this tag is SSL-compliant or not. This is a read-only field. + */ + sslCompliant?: boolean | null; + /** + * Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field. + */ + status?: string | null; + /** + * Subaccount ID of this event tag. This is a read-only field that can be left blank. + */ + subaccountId?: string | null; + /** + * Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field. + */ + type?: string | null; + /** + * Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion. + */ + url?: string | null; + /** + * Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type. + */ + urlEscapeLevels?: number | null; + } + /** + * Event tag override information. + */ + export interface Schema$EventTagOverride { + /** + * Whether this override is enabled. + */ + enabled?: boolean | null; + /** + * ID of this event tag override. This is a read-only, auto-generated field. + */ + id?: string | null; + } + /** + * Event Tag List Response + */ + export interface Schema$EventTagsListResponse { + /** + * Event tag collection. + */ + eventTags?: Schema$EventTag[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTagsListResponse". + */ + kind?: string | null; + } + /** + * Represents a File resource. A file contains the metadata for a report run. It shows the status of the run and holds the URLs to the generated report data if the run is finished and the status is "REPORT_AVAILABLE". + */ + export interface Schema$File { + /** + * The date range for which the file has report data. The date range will always be the absolute date range for which the report is run. + */ + dateRange?: Schema$DateRange; + /** + * The eTag of this response for caching purposes. + */ + etag?: string | null; + /** + * The filename of the file. + */ + fileName?: string | null; + /** + * The output format of the report. Only available once the file is available. + */ + format?: string | null; + /** + * The unique ID of this report file. + */ + id?: string | null; + /** + * The kind of resource this is, in this case dfareporting#file. + */ + kind?: string | null; + /** + * The timestamp in milliseconds since epoch when this file was last modified. + */ + lastModifiedTime?: string | null; + /** + * The ID of the report this file was generated from. + */ + reportId?: string | null; + /** + * The status of the report file. + */ + status?: string | null; + /** + * The URLs where the completed report file can be downloaded. + */ + urls?: {apiUrl?: string; browserUrl?: string} | null; + } + /** + * Represents the list of File resources. + */ + export interface Schema$FileList { + /** + * The eTag of this response for caching purposes. + */ + etag?: string | null; + /** + * The files returned in this response. + */ + items?: Schema$File[]; + /** + * The kind of list this is, in this case dfareporting#fileList. + */ + kind?: string | null; + /** + * Continuation token used to page through files. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted. + */ + nextPageToken?: string | null; + } + /** + * Flight + */ + export interface Schema$Flight { + /** + * Inventory item flight end date. + */ + endDate?: string | null; + /** + * Rate or cost of this flight. + */ + rateOrCost?: string | null; + /** + * Inventory item flight start date. + */ + startDate?: string | null; + /** + * Units of this flight. + */ + units?: string | null; + } + /** + * Floodlight Activity GenerateTag Response + */ + export interface Schema$FloodlightActivitiesGenerateTagResponse { + /** + * Generated tag for this Floodlight activity. For global site tags, this is the event snippet. + */ + floodlightActivityTag?: string | null; + /** + * The global snippet section of a global site tag. The global site tag sets new cookies on your domain, which will store a unique identifier for a user or the ad click that brought the user to your site. Learn more. + */ + globalSiteTagGlobalSnippet?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesGenerateTagResponse". + */ + kind?: string | null; + } + /** + * Floodlight Activity List Response + */ + export interface Schema$FloodlightActivitiesListResponse { + /** + * Floodlight activity collection. + */ + floodlightActivities?: Schema$FloodlightActivity[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * Contains properties of a Floodlight activity. + */ + export interface Schema$FloodlightActivity { + /** + * Account ID of this floodlight activity. This is a read-only field that can be left blank. + */ + accountId?: string | null; + /** + * Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser. + */ + advertiserId?: string | null; + /** + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING. + */ + cacheBustingType?: string | null; + /** + * Counting method for conversions for this floodlight activity. This is a required field. + */ + countingMethod?: string | null; + /** + * Dynamic floodlight tags. + */ + defaultTags?: Schema$FloodlightActivityDynamicTag[]; + /** + * URL where this tag will be deployed. If specified, must be less than 256 characters long. + */ + expectedUrl?: string | null; + /** + * Floodlight activity group ID of this floodlight activity. This is a required field. + */ + floodlightActivityGroupId?: string | null; + /** + * Name of the associated floodlight activity group. This is a read-only field. + */ + floodlightActivityGroupName?: string | null; + /** + * Tag string of the associated floodlight activity group. This is a read-only field. + */ + floodlightActivityGroupTagString?: string | null; + /** + * Type of the associated floodlight activity group. This is a read-only field. + */ + floodlightActivityGroupType?: string | null; + /** + * Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration. + */ + floodlightConfigurationId?: string | null; + /** + * Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. + */ + floodlightConfigurationIdDimensionValue?: Schema$DimensionValue; + /** + * The type of Floodlight tag this activity will generate. This is a required field. + */ + floodlightTagType?: string | null; + /** + * Whether this activity is archived. + */ + hidden?: boolean | null; + /** + * ID of this floodlight activity. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity". + */ + kind?: string | null; + /** + * Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes. + */ + name?: string | null; + /** + * General notes or implementation instructions for the tag. + */ + notes?: string | null; + /** + * Publisher dynamic floodlight tags. + */ + publisherTags?: Schema$FloodlightActivityPublisherDynamicTag[]; + /** + * Whether this tag should use SSL. + */ + secure?: boolean | null; + /** + * Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags. + */ + sslCompliant?: boolean | null; + /** + * Whether this floodlight activity must be SSL-compliant. + */ + sslRequired?: boolean | null; + /** + * Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. + */ + subaccountId?: string | null; + /** + * Tag format type for the floodlight activity. If left blank, the tag format will default to HTML. + */ + tagFormat?: string | null; + /** + * Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion. + */ + tagString?: string | null; + /** + * List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive. + */ + userDefinedVariableTypes?: string[] | null; + } + /** + * Dynamic Tag + */ + export interface Schema$FloodlightActivityDynamicTag { + /** + * ID of this dynamic tag. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Name of this tag. + */ + name?: string | null; + /** + * Tag code. + */ + tag?: string | null; + } + /** + * Contains properties of a Floodlight activity group. + */ + export interface Schema$FloodlightActivityGroup { + /** + * Account ID of this floodlight activity group. This is a read-only field that can be left blank. + */ + accountId?: string | null; + /** + * Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser. + */ + advertiserId?: string | null; + /** + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Floodlight configuration ID of this floodlight activity group. This is a required field. + */ + floodlightConfigurationId?: string | null; + /** + * Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. + */ + floodlightConfigurationIdDimensionValue?: Schema$DimensionValue; + /** + * ID of this floodlight activity group. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup". + */ + kind?: string | null; + /** + * Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes. + */ + name?: string | null; + /** + * Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank. + */ + subaccountId?: string | null; + /** + * Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion. + */ + tagString?: string | null; + /** + * Type of the floodlight activity group. This is a required field that is read-only after insertion. + */ + type?: string | null; + } + /** + * Floodlight Activity Group List Response + */ + export interface Schema$FloodlightActivityGroupsListResponse { + /** + * Floodlight activity group collection. + */ + floodlightActivityGroups?: Schema$FloodlightActivityGroup[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroupsListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * Publisher Dynamic Tag + */ + export interface Schema$FloodlightActivityPublisherDynamicTag { + /** + * Whether this tag is applicable only for click-throughs. + */ + clickThrough?: boolean | null; + /** + * Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated. + */ + directorySiteId?: string | null; + /** + * Dynamic floodlight tag. + */ + dynamicTag?: Schema$FloodlightActivityDynamicTag; + /** + * Site ID of this dynamic tag. + */ + siteId?: string | null; + /** + * Dimension value for the ID of the site. This is a read-only, auto-generated field. + */ + siteIdDimensionValue?: Schema$DimensionValue; + /** + * Whether this tag is applicable only for view-throughs. + */ + viewThrough?: boolean | null; + } + /** + * Contains properties of a Floodlight configuration. + */ + export interface Schema$FloodlightConfiguration { + /** + * Account ID of this floodlight configuration. This is a read-only field that can be left blank. + */ + accountId?: string | null; + /** + * Advertiser ID of the parent advertiser of this floodlight configuration. + */ + advertiserId?: string | null; + /** + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Whether advertiser data is shared with Google Analytics. + */ + analyticsDataSharingEnabled?: boolean | null; + /** + * Custom Viewability metric for the floodlight configuration. + */ + customViewabilityMetric?: Schema$CustomViewabilityMetric; + /** + * Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting. + */ + exposureToConversionEnabled?: boolean | null; + /** + * Day that will be counted as the first day of the week in reports. This is a required field. + */ + firstDayOfWeek?: string | null; + /** + * ID of this floodlight configuration. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Whether in-app attribution tracking is enabled. + */ + inAppAttributionTrackingEnabled?: boolean | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration". + */ + kind?: string | null; + /** + * Lookback window settings for this floodlight configuration. + */ + lookbackConfiguration?: Schema$LookbackConfiguration; + /** + * Types of attribution options for natural search conversions. + */ + naturalSearchConversionAttributionOption?: string | null; + /** + * Settings for Campaign Manager Omniture integration. + */ + omnitureSettings?: Schema$OmnitureSettings; + /** + * Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank. + */ + subaccountId?: string | null; + /** + * Configuration settings for dynamic and image floodlight tags. + */ + tagSettings?: Schema$TagSettings; + /** + * List of third-party authentication tokens enabled for this configuration. + */ + thirdPartyAuthenticationTokens?: Schema$ThirdPartyAuthenticationToken[]; + /** + * List of user defined variables enabled for this configuration. + */ + userDefinedVariableConfigurations?: Schema$UserDefinedVariableConfiguration[]; + } + /** + * Floodlight Configuration List Response + */ + export interface Schema$FloodlightConfigurationsListResponse { + /** + * Floodlight configuration collection. + */ + floodlightConfigurations?: Schema$FloodlightConfiguration[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfigurationsListResponse". + */ + kind?: string | null; + } + /** + * Represents fields that are compatible to be selected for a report of type "FlOODLIGHT". + */ + export interface Schema$FloodlightReportCompatibleFields { + /** + * Dimensions which are compatible to be selected in the "dimensionFilters" section of the report. + */ + dimensionFilters?: Schema$Dimension[]; + /** + * Dimensions which are compatible to be selected in the "dimensions" section of the report. + */ + dimensions?: Schema$Dimension[]; + /** + * The kind of resource this is, in this case dfareporting#floodlightReportCompatibleFields. + */ + kind?: string | null; + /** + * Metrics which are compatible to be selected in the "metricNames" section of the report. + */ + metrics?: Schema$Metric[]; + } + /** + * Frequency Cap. + */ + export interface Schema$FrequencyCap { + /** + * Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive. + */ + duration?: string | null; + /** + * Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive. + */ + impressions?: string | null; + } + /** + * FsCommand. + */ + export interface Schema$FsCommand { + /** + * Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER. + */ + left?: number | null; + /** + * Position in the browser where the window will open. + */ + positionOption?: string | null; + /** + * Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER. + */ + top?: number | null; + /** + * Height of the window. + */ + windowHeight?: number | null; + /** + * Width of the window. + */ + windowWidth?: number | null; + } + /** + * Geographical Targeting. + */ + export interface Schema$GeoTargeting { + /** + * Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city. + */ + cities?: Schema$City[]; + /** + * Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country. + */ + countries?: Schema$Country[]; + /** + * Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad. + */ + excludeCountries?: boolean | null; + /** + * Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro. + */ + metros?: Schema$Metro[]; + /** + * Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code. + */ + postalCodes?: Schema$PostalCode[]; + /** + * Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region. + */ + regions?: Schema$Region[]; + } + /** + * Represents a buy from the Planning inventory store. + */ + export interface Schema$InventoryItem { + /** + * Account ID of this inventory item. + */ + accountId?: string | null; + /** + * Ad slots of this inventory item. If this inventory item represents a standalone placement, there will be exactly one ad slot. If this inventory item represents a placement group, there will be more than one ad slot, each representing one child placement in that placement group. + */ + adSlots?: Schema$AdSlot[]; + /** + * Advertiser ID of this inventory item. + */ + advertiserId?: string | null; + /** + * Content category ID of this inventory item. + */ + contentCategoryId?: string | null; + /** + * Estimated click-through rate of this inventory item. + */ + estimatedClickThroughRate?: string | null; + /** + * Estimated conversion rate of this inventory item. + */ + estimatedConversionRate?: string | null; + /** + * ID of this inventory item. + */ + id?: string | null; + /** + * Whether this inventory item is in plan. + */ + inPlan?: boolean | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItem". + */ + kind?: string | null; + /** + * Information about the most recent modification of this inventory item. + */ + lastModifiedInfo?: Schema$LastModifiedInfo; + /** + * Name of this inventory item. For standalone inventory items, this is the same name as that of its only ad slot. For group inventory items, this can differ from the name of any of its ad slots. + */ + name?: string | null; + /** + * Negotiation channel ID of this inventory item. + */ + negotiationChannelId?: string | null; + /** + * Order ID of this inventory item. + */ + orderId?: string | null; + /** + * Placement strategy ID of this inventory item. + */ + placementStrategyId?: string | null; + /** + * Pricing of this inventory item. + */ + pricing?: Schema$Pricing; + /** + * Project ID of this inventory item. + */ + projectId?: string | null; + /** + * RFP ID of this inventory item. + */ + rfpId?: string | null; + /** + * ID of the site this inventory item is associated with. + */ + siteId?: string | null; + /** + * Subaccount ID of this inventory item. + */ + subaccountId?: string | null; + /** + * Type of inventory item. + */ + type?: string | null; + } + /** + * Inventory item List Response + */ + export interface Schema$InventoryItemsListResponse { + /** + * Inventory item collection + */ + inventoryItems?: Schema$InventoryItem[]; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItemsListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * Key Value Targeting Expression. + */ + export interface Schema$KeyValueTargetingExpression { + /** + * Keyword expression being targeted by the ad. + */ + expression?: string | null; + } + /** + * Contains information about where a user's browser is taken after the user clicks an ad. + */ + export interface Schema$LandingPage { + /** + * Advertiser ID of this landing page. This is a required field. + */ + advertiserId?: string | null; + /** + * Whether this landing page has been archived. + */ + archived?: boolean | null; + /** + * Links that will direct the user to a mobile app, if installed. + */ + deepLinks?: Schema$DeepLink[]; + /** + * ID of this landing page. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage". + */ + kind?: string | null; + /** + * Name of this landing page. This is a required field. It must be less than 256 characters long. + */ + name?: string | null; + /** + * URL of this landing page. This is a required field. + */ + url?: string | null; + } + /** + * Contains information about a language that can be targeted by ads. + */ + export interface Schema$Language { + /** + * Language ID of this language. This is the ID used for targeting and generating reports. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#language". + */ + kind?: string | null; + /** + * Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese. + */ + languageCode?: string | null; + /** + * Name of this language. + */ + name?: string | null; + } + /** + * Language List Response + */ + export interface Schema$LanguagesListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#languagesListResponse". + */ + kind?: string | null; + /** + * Language collection. + */ + languages?: Schema$Language[]; + } + /** + * Language Targeting. + */ + export interface Schema$LanguageTargeting { + /** + * Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated. + */ + languages?: Schema$Language[]; + } + /** + * Modification timestamp. + */ + export interface Schema$LastModifiedInfo { + /** + * Timestamp of the last change in milliseconds since epoch. + */ + time?: string | null; + } + /** + * A group clause made up of list population terms representing constraints joined by ORs. + */ + export interface Schema$ListPopulationClause { + /** + * Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs. + */ + terms?: Schema$ListPopulationTerm[]; + } + /** + * Remarketing List Population Rule. + */ + export interface Schema$ListPopulationRule { + /** + * Floodlight activity ID associated with this rule. This field can be left blank. + */ + floodlightActivityId?: string | null; + /** + * Name of floodlight activity associated with this rule. This is a read-only, auto-generated field. + */ + floodlightActivityName?: string | null; + /** + * Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs. + */ + listPopulationClauses?: Schema$ListPopulationClause[]; + } + /** + * Remarketing List Population Rule Term. + */ + export interface Schema$ListPopulationTerm { + /** + * Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default. + */ + contains?: boolean | null; + /** + * Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. + */ + negation?: boolean | null; + /** + * Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. + */ + operator?: string | null; + /** + * ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. + */ + remarketingListId?: string | null; + /** + * List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable. + */ + type?: string | null; + /** + * Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. + */ + value?: string | null; + /** + * Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM. + */ + variableFriendlyName?: string | null; + /** + * Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM. + */ + variableName?: string | null; + } + /** + * Remarketing List Targeting Expression. + */ + export interface Schema$ListTargetingExpression { + /** + * Expression describing which lists are being targeted by the ad. + */ + expression?: string | null; + } + /** + * Lookback configuration settings. + */ + export interface Schema$LookbackConfiguration { + /** + * Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive. + */ + clickDuration?: number | null; + /** + * Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive. + */ + postImpressionActivitiesDuration?: number | null; + } + /** + * Represents a metric. + */ + export interface Schema$Metric { + /** + * The kind of resource this is, in this case dfareporting#metric. + */ + kind?: string | null; + /** + * The metric name, e.g. dfa:impressions + */ + name?: string | null; + } + /** + * Contains information about a metro region that can be targeted by ads. + */ + export interface Schema$Metro { + /** + * Country code of the country to which this metro region belongs. + */ + countryCode?: string | null; + /** + * DART ID of the country to which this metro region belongs. + */ + countryDartId?: string | null; + /** + * DART ID of this metro region. + */ + dartId?: string | null; + /** + * DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code. + */ + dmaId?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro". + */ + kind?: string | null; + /** + * Metro code of this metro region. This is equivalent to dma_id. + */ + metroCode?: string | null; + /** + * Name of this metro region. + */ + name?: string | null; + } + /** + * Metro List Response + */ + export interface Schema$MetrosListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#metrosListResponse". + */ + kind?: string | null; + /** + * Metro collection. + */ + metros?: Schema$Metro[]; + } + /** + * Contains information about a mobile app. Used as a landing page deep link. + */ + export interface Schema$MobileApp { + /** + * Mobile app directory. + */ + directory?: string | null; + /** + * ID of this mobile app. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp". + */ + kind?: string | null; + /** + * Publisher name. + */ + publisherName?: string | null; + /** + * Title of this mobile app. + */ + title?: string | null; + } + /** + * Mobile app List Response + */ + export interface Schema$MobileAppsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileAppsListResponse". + */ + kind?: string | null; + /** + * Mobile apps collection. + */ + mobileApps?: Schema$MobileApp[]; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + } + /** + * Contains information about a mobile carrier that can be targeted by ads. + */ + export interface Schema$MobileCarrier { + /** + * Country code of the country to which this mobile carrier belongs. + */ + countryCode?: string | null; + /** + * DART ID of the country to which this mobile carrier belongs. + */ + countryDartId?: string | null; + /** + * ID of this mobile carrier. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier". + */ + kind?: string | null; + /** + * Name of this mobile carrier. + */ + name?: string | null; + } + /** + * Mobile Carrier List Response + */ + export interface Schema$MobileCarriersListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarriersListResponse". + */ + kind?: string | null; + /** + * Mobile carrier collection. + */ + mobileCarriers?: Schema$MobileCarrier[]; + } + /** + * Object Filter. + */ + export interface Schema$ObjectFilter { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter". + */ + kind?: string | null; + /** + * Applicable when status is ASSIGNED. The user has access to objects with these object IDs. + */ + objectIds?: string[] | null; + /** + * Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list. + */ + status?: string | null; + } + /** + * Offset Position. + */ + export interface Schema$OffsetPosition { + /** + * Offset distance from left side of an asset or a window. + */ + left?: number | null; + /** + * Offset distance from top side of an asset or a window. + */ + top?: number | null; + } + /** + * Omniture Integration Settings. + */ + export interface Schema$OmnitureSettings { + /** + * Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true. + */ + omnitureCostDataEnabled?: boolean | null; + /** + * Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled. + */ + omnitureIntegrationEnabled?: boolean | null; + } + /** + * Contains information about an operating system that can be targeted by ads. + */ + export interface Schema$OperatingSystem { + /** + * DART ID of this operating system. This is the ID used for targeting. + */ + dartId?: string | null; + /** + * Whether this operating system is for desktop. + */ + desktop?: boolean | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". + */ + kind?: string | null; + /** + * Whether this operating system is for mobile. + */ + mobile?: boolean | null; + /** + * Name of this operating system. + */ + name?: string | null; + } + /** + * Operating System List Response + */ + export interface Schema$OperatingSystemsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemsListResponse". + */ + kind?: string | null; + /** + * Operating system collection. + */ + operatingSystems?: Schema$OperatingSystem[]; + } + /** + * Contains information about a particular version of an operating system that can be targeted by ads. + */ + export interface Schema$OperatingSystemVersion { + /** + * ID of this operating system version. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion". + */ + kind?: string | null; + /** + * Major version (leftmost number) of this operating system version. + */ + majorVersion?: string | null; + /** + * Minor version (number after the first dot) of this operating system version. + */ + minorVersion?: string | null; + /** + * Name of this operating system version. + */ + name?: string | null; + /** + * Operating system of this operating system version. + */ + operatingSystem?: Schema$OperatingSystem; + } + /** + * Operating System Version List Response + */ + export interface Schema$OperatingSystemVersionsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersionsListResponse". + */ + kind?: string | null; + /** + * Operating system version collection. + */ + operatingSystemVersions?: Schema$OperatingSystemVersion[]; + } + /** + * Creative optimization activity. + */ + export interface Schema$OptimizationActivity { + /** + * Floodlight activity ID of this optimization activity. This is a required field. + */ + floodlightActivityId?: string | null; + /** + * Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field. + */ + floodlightActivityIdDimensionValue?: Schema$DimensionValue; + /** + * Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1. + */ + weight?: number | null; + } + /** + * Describes properties of a Planning order. + */ + export interface Schema$Order { + /** + * Account ID of this order. + */ + accountId?: string | null; + /** + * Advertiser ID of this order. + */ + advertiserId?: string | null; + /** + * IDs for users that have to approve documents created for this order. + */ + approverUserProfileIds?: string[] | null; + /** + * Buyer invoice ID associated with this order. + */ + buyerInvoiceId?: string | null; + /** + * Name of the buyer organization. + */ + buyerOrganizationName?: string | null; + /** + * Comments in this order. + */ + comments?: string | null; + /** + * Contacts for this order. + */ + contacts?: Schema$OrderContact[]; + /** + * ID of this order. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#order". + */ + kind?: string | null; + /** + * Information about the most recent modification of this order. + */ + lastModifiedInfo?: Schema$LastModifiedInfo; + /** + * Name of this order. + */ + name?: string | null; + /** + * Notes of this order. + */ + notes?: string | null; + /** + * ID of the terms and conditions template used in this order. + */ + planningTermId?: string | null; + /** + * Project ID of this order. + */ + projectId?: string | null; + /** + * Seller order ID associated with this order. + */ + sellerOrderId?: string | null; + /** + * Name of the seller organization. + */ + sellerOrganizationName?: string | null; + /** + * Site IDs this order is associated with. + */ + siteId?: string[] | null; + /** + * Free-form site names this order is associated with. + */ + siteNames?: string[] | null; + /** + * Subaccount ID of this order. + */ + subaccountId?: string | null; + /** + * Terms and conditions of this order. + */ + termsAndConditions?: string | null; + } + /** + * Contact of an order. + */ + export interface Schema$OrderContact { + /** + * Free-form information about this contact. It could be any information related to this contact in addition to type, title, name, and signature user profile ID. + */ + contactInfo?: string | null; + /** + * Name of this contact. + */ + contactName?: string | null; + /** + * Title of this contact. + */ + contactTitle?: string | null; + /** + * Type of this contact. + */ + contactType?: string | null; + /** + * ID of the user profile containing the signature that will be embedded into order documents. + */ + signatureUserProfileId?: string | null; + } + /** + * Contains properties of a Planning order document. + */ + export interface Schema$OrderDocument { + /** + * Account ID of this order document. + */ + accountId?: string | null; + /** + * Advertiser ID of this order document. + */ + advertiserId?: string | null; + /** + * The amended order document ID of this order document. An order document can be created by optionally amending another order document so that the change history can be preserved. + */ + amendedOrderDocumentId?: string | null; + /** + * IDs of users who have approved this order document. + */ + approvedByUserProfileIds?: string[] | null; + /** + * Whether this order document is cancelled. + */ + cancelled?: boolean | null; + /** + * Information about the creation of this order document. + */ + createdInfo?: Schema$LastModifiedInfo; + /** + * Effective date of this order document. + */ + effectiveDate?: string | null; + /** + * ID of this order document. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocument". + */ + kind?: string | null; + /** + * List of email addresses that received the last sent document. + */ + lastSentRecipients?: string[] | null; + /** + * Timestamp of the last email sent with this order document. + */ + lastSentTime?: string | null; + /** + * ID of the order from which this order document is created. + */ + orderId?: string | null; + /** + * Project ID of this order document. + */ + projectId?: string | null; + /** + * Whether this order document has been signed. + */ + signed?: boolean | null; + /** + * Subaccount ID of this order document. + */ + subaccountId?: string | null; + /** + * Title of this order document. + */ + title?: string | null; + /** + * Type of this order document + */ + type?: string | null; + } + /** + * Order document List Response + */ + export interface Schema$OrderDocumentsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocumentsListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + /** + * Order document collection + */ + orderDocuments?: Schema$OrderDocument[]; + } + /** + * Order List Response + */ + export interface Schema$OrdersListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#ordersListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + /** + * Order collection. + */ + orders?: Schema$Order[]; + } + /** + * Represents fields that are compatible to be selected for a report of type "PATH_TO_CONVERSION". + */ + export interface Schema$PathToConversionReportCompatibleFields { + /** + * Conversion dimensions which are compatible to be selected in the "conversionDimensions" section of the report. + */ + conversionDimensions?: Schema$Dimension[]; + /** + * Custom floodlight variables which are compatible to be selected in the "customFloodlightVariables" section of the report. + */ + customFloodlightVariables?: Schema$Dimension[]; + /** + * The kind of resource this is, in this case dfareporting#pathToConversionReportCompatibleFields. + */ + kind?: string | null; + /** + * Metrics which are compatible to be selected in the "metricNames" section of the report. + */ + metrics?: Schema$Metric[]; + /** + * Per-interaction dimensions which are compatible to be selected in the "perInteractionDimensions" section of the report. + */ + perInteractionDimensions?: Schema$Dimension[]; + } + /** + * Contains properties of a placement. + */ + export interface Schema$Placement { + /** + * Account ID of this placement. This field can be left blank. + */ + accountId?: string | null; + /** + * Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect. + */ + adBlockingOptOut?: boolean | null; + /** + * Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used. + */ + additionalSizes?: Schema$Size[]; + /** + * Advertiser ID of this placement. This field can be left blank. + */ + advertiserId?: string | null; + /** + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Whether this placement is archived. + */ + archived?: boolean | null; + /** + * Campaign ID of this placement. This field is a required field on insertion. + */ + campaignId?: string | null; + /** + * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. + */ + campaignIdDimensionValue?: Schema$DimensionValue; + /** + * Comments for this placement. + */ + comment?: string | null; + /** + * Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion. + */ + compatibility?: string | null; + /** + * ID of the content category assigned to this placement. + */ + contentCategoryId?: string | null; + /** + * Information about the creation of this placement. This is a read-only field. + */ + createInfo?: Schema$LastModifiedInfo; + /** + * Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion. + */ + directorySiteId?: string | null; + /** + * Dimension value for the ID of the directory site. This is a read-only, auto-generated field. + */ + directorySiteIdDimensionValue?: Schema$DimensionValue; + /** + * External ID for this placement. + */ + externalId?: string | null; + /** + * ID of this placement. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Dimension value for the ID of this placement. This is a read-only, auto-generated field. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Key name of this placement. This is a read-only, auto-generated field. + */ + keyName?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement". + */ + kind?: string | null; + /** + * Information about the most recent modification of this placement. This is a read-only field. + */ + lastModifiedInfo?: Schema$LastModifiedInfo; + /** + * Lookback window settings for this placement. + */ + lookbackConfiguration?: Schema$LookbackConfiguration; + /** + * Name of this placement.This is a required field and must be less than 256 characters long. + */ + name?: string | null; + /** + * Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements. + */ + paymentApproved?: boolean | null; + /** + * Payment source for this placement. This is a required field that is read-only after insertion. + */ + paymentSource?: string | null; + /** + * ID of this placement's group, if applicable. + */ + placementGroupId?: string | null; + /** + * Dimension value for the ID of the placement group. This is a read-only, auto-generated field. + */ + placementGroupIdDimensionValue?: Schema$DimensionValue; + /** + * ID of the placement strategy assigned to this placement. + */ + placementStrategyId?: string | null; + /** + * Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType. + */ + pricingSchedule?: Schema$PricingSchedule; + /** + * Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement. + */ + primary?: boolean | null; + /** + * Information about the last publisher update. This is a read-only field. + */ + publisherUpdateInfo?: Schema$LastModifiedInfo; + /** + * Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion. + */ + siteId?: string | null; + /** + * Dimension value for the ID of the site. This is a read-only, auto-generated field. + */ + siteIdDimensionValue?: Schema$DimensionValue; + /** + * Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion. + */ + size?: Schema$Size; + /** + * Whether creatives assigned to this placement must be SSL-compliant. + */ + sslRequired?: boolean | null; + /** + * Third-party placement status. + */ + status?: string | null; + /** + * Subaccount ID of this placement. This field can be left blank. + */ + subaccountId?: string | null; + /** + * Tag formats to generate for this placement. This field is required on insertion. Acceptable values are: - "PLACEMENT_TAG_STANDARD" - "PLACEMENT_TAG_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_IFRAME_ILAYER" - "PLACEMENT_TAG_INTERNAL_REDIRECT" - "PLACEMENT_TAG_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT" - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT" - "PLACEMENT_TAG_CLICK_COMMANDS" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4" - "PLACEMENT_TAG_TRACKING" - "PLACEMENT_TAG_TRACKING_IFRAME" - "PLACEMENT_TAG_TRACKING_JAVASCRIPT" + */ + tagFormats?: string[] | null; + /** + * Tag settings for this placement. + */ + tagSetting?: Schema$TagSetting; + /** + * Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView. + */ + videoActiveViewOptOut?: boolean | null; + /** + * A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility. + */ + videoSettings?: Schema$VideoSettings; + /** + * VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement. Note: Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH. + */ + vpaidAdapterChoice?: string | null; + } + /** + * Placement Assignment. + */ + export interface Schema$PlacementAssignment { + /** + * Whether this placement assignment is active. When true, the placement will be included in the ad's rotation. + */ + active?: boolean | null; + /** + * ID of the placement to be assigned. This is a required field. + */ + placementId?: string | null; + /** + * Dimension value for the ID of the placement. This is a read-only, auto-generated field. + */ + placementIdDimensionValue?: Schema$DimensionValue; + /** + * Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated. + */ + sslRequired?: boolean | null; + } + /** + * Contains properties of a package or roadblock. + */ + export interface Schema$PlacementGroup { + /** + * Account ID of this placement group. This is a read-only field that can be left blank. + */ + accountId?: string | null; + /** + * Advertiser ID of this placement group. This is a required field on insertion. + */ + advertiserId?: string | null; + /** + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Whether this placement group is archived. + */ + archived?: boolean | null; + /** + * Campaign ID of this placement group. This field is required on insertion. + */ + campaignId?: string | null; + /** + * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. + */ + campaignIdDimensionValue?: Schema$DimensionValue; + /** + * IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field. + */ + childPlacementIds?: string[] | null; + /** + * Comments for this placement group. + */ + comment?: string | null; + /** + * ID of the content category assigned to this placement group. + */ + contentCategoryId?: string | null; + /** + * Information about the creation of this placement group. This is a read-only field. + */ + createInfo?: Schema$LastModifiedInfo; + /** + * Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion. + */ + directorySiteId?: string | null; + /** + * Dimension value for the ID of the directory site. This is a read-only, auto-generated field. + */ + directorySiteIdDimensionValue?: Schema$DimensionValue; + /** + * External ID for this placement. + */ + externalId?: string | null; + /** + * ID of this placement group. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Dimension value for the ID of this placement group. This is a read-only, auto-generated field. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup". + */ + kind?: string | null; + /** + * Information about the most recent modification of this placement group. This is a read-only field. + */ + lastModifiedInfo?: Schema$LastModifiedInfo; + /** + * Name of this placement group. This is a required field and must be less than 256 characters long. + */ + name?: string | null; + /** + * Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion. + */ + placementGroupType?: string | null; + /** + * ID of the placement strategy assigned to this placement group. + */ + placementStrategyId?: string | null; + /** + * Pricing schedule of this placement group. This field is required on insertion. + */ + pricingSchedule?: Schema$PricingSchedule; + /** + * ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements. + */ + primaryPlacementId?: string | null; + /** + * Dimension value for the ID of the primary placement. This is a read-only, auto-generated field. + */ + primaryPlacementIdDimensionValue?: Schema$DimensionValue; + /** + * Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion. + */ + siteId?: string | null; + /** + * Dimension value for the ID of the site. This is a read-only, auto-generated field. + */ + siteIdDimensionValue?: Schema$DimensionValue; + /** + * Subaccount ID of this placement group. This is a read-only field that can be left blank. + */ + subaccountId?: string | null; + } + /** + * Placement Group List Response + */ + export interface Schema$PlacementGroupsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroupsListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + /** + * Placement group collection. + */ + placementGroups?: Schema$PlacementGroup[]; + } + /** + * Placement GenerateTags Response + */ + export interface Schema$PlacementsGenerateTagsResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsGenerateTagsResponse". + */ + kind?: string | null; + /** + * Set of generated tags for the specified placements. + */ + placementTags?: Schema$PlacementTag[]; + } + /** + * Placement List Response + */ + export interface Schema$PlacementsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + /** + * Placement collection. + */ + placements?: Schema$Placement[]; + } + /** + * Placement Strategy List Response + */ + export interface Schema$PlacementStrategiesListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategiesListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + /** + * Placement strategy collection. + */ + placementStrategies?: Schema$PlacementStrategy[]; + } + /** + * Contains properties of a placement strategy. + */ + export interface Schema$PlacementStrategy { + /** + * Account ID of this placement strategy.This is a read-only field that can be left blank. + */ + accountId?: string | null; + /** + * ID of this placement strategy. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy". + */ + kind?: string | null; + /** + * Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account. + */ + name?: string | null; + } + /** + * Placement Tag + */ + export interface Schema$PlacementTag { + /** + * Placement ID + */ + placementId?: string | null; + /** + * Tags generated for this placement. + */ + tagDatas?: Schema$TagData[]; + } + /** + * Contains information about a platform type that can be targeted by ads. + */ + export interface Schema$PlatformType { + /** + * ID of this platform type. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType". + */ + kind?: string | null; + /** + * Name of this platform type. + */ + name?: string | null; + } + /** + * Platform Type List Response + */ + export interface Schema$PlatformTypesListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformTypesListResponse". + */ + kind?: string | null; + /** + * Platform type collection. + */ + platformTypes?: Schema$PlatformType[]; + } + /** + * Popup Window Properties. + */ + export interface Schema$PopupWindowProperties { + /** + * Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID + */ + dimension?: Schema$Size; + /** + * Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES. + */ + offset?: Schema$OffsetPosition; + /** + * Popup window position either centered or at specific coordinate. + */ + positionType?: string | null; + /** + * Whether to display the browser address bar. + */ + showAddressBar?: boolean | null; + /** + * Whether to display the browser menu bar. + */ + showMenuBar?: boolean | null; + /** + * Whether to display the browser scroll bar. + */ + showScrollBar?: boolean | null; + /** + * Whether to display the browser status bar. + */ + showStatusBar?: boolean | null; + /** + * Whether to display the browser tool bar. + */ + showToolBar?: boolean | null; + /** + * Title of popup window. + */ + title?: string | null; + } + /** + * Contains information about a postal code that can be targeted by ads. + */ + export interface Schema$PostalCode { + /** + * Postal code. This is equivalent to the id field. + */ + code?: string | null; + /** + * Country code of the country to which this postal code belongs. + */ + countryCode?: string | null; + /** + * DART ID of the country to which this postal code belongs. + */ + countryDartId?: string | null; + /** + * ID of this postal code. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode". + */ + kind?: string | null; + } + /** + * Postal Code List Response + */ + export interface Schema$PostalCodesListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCodesListResponse". + */ + kind?: string | null; + /** + * Postal code collection. + */ + postalCodes?: Schema$PostalCode[]; + } + /** + * Pricing Information + */ + export interface Schema$Pricing { + /** + * Cap cost type of this inventory item. + */ + capCostType?: string | null; + /** + * End date of this inventory item. + */ + endDate?: string | null; + /** + * Flights of this inventory item. A flight (a.k.a. pricing period) represents the inventory item pricing information for a specific period of time. + */ + flights?: Schema$Flight[]; + /** + * Group type of this inventory item if it represents a placement group. Is null otherwise. There are two type of placement groups: PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items that acts as a single pricing point for a group of tags. PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned inventory items to be marked as primary. + */ + groupType?: string | null; + /** + * Pricing type of this inventory item. + */ + pricingType?: string | null; + /** + * Start date of this inventory item. + */ + startDate?: string | null; + } + /** + * Pricing Schedule + */ + export interface Schema$PricingSchedule { + /** + * Placement cap cost option. + */ + capCostOption?: string | null; + /** + * Whether cap costs are ignored by ad serving. + */ + disregardOverdelivery?: boolean | null; + /** + * Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion. + */ + endDate?: string | null; + /** + * Whether this placement is flighted. If true, pricing periods will be computed automatically. + */ + flighted?: boolean | null; + /** + * Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA. + */ + floodlightActivityId?: string | null; + /** + * Pricing periods for this placement. + */ + pricingPeriods?: Schema$PricingSchedulePricingPeriod[]; + /** + * Placement pricing type. This field is required on insertion. + */ + pricingType?: string | null; + /** + * Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion. + */ + startDate?: string | null; + /** + * Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. + */ + testingStartDate?: string | null; + } + /** + * Pricing Period + */ + export interface Schema$PricingSchedulePricingPeriod { + /** + * Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. + */ + endDate?: string | null; + /** + * Comments for this pricing period. + */ + pricingComment?: string | null; + /** + * Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. + */ + rateOrCostNanos?: string | null; + /** + * Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. + */ + startDate?: string | null; + /** + * Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. + */ + units?: string | null; + } + /** + * Contains properties of a Planning project. + */ + export interface Schema$Project { + /** + * Account ID of this project. + */ + accountId?: string | null; + /** + * Advertiser ID of this project. + */ + advertiserId?: string | null; + /** + * Audience age group of this project. + */ + audienceAgeGroup?: string | null; + /** + * Audience gender of this project. + */ + audienceGender?: string | null; + /** + * Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar. + */ + budget?: string | null; + /** + * Client billing code of this project. + */ + clientBillingCode?: string | null; + /** + * Name of the project client. + */ + clientName?: string | null; + /** + * End date of the project. + */ + endDate?: string | null; + /** + * ID of this project. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#project". + */ + kind?: string | null; + /** + * Information about the most recent modification of this project. + */ + lastModifiedInfo?: Schema$LastModifiedInfo; + /** + * Name of this project. + */ + name?: string | null; + /** + * Overview of this project. + */ + overview?: string | null; + /** + * Start date of the project. + */ + startDate?: string | null; + /** + * Subaccount ID of this project. + */ + subaccountId?: string | null; + /** + * Number of clicks that the advertiser is targeting. + */ + targetClicks?: string | null; + /** + * Number of conversions that the advertiser is targeting. + */ + targetConversions?: string | null; + /** + * CPA that the advertiser is targeting. + */ + targetCpaNanos?: string | null; + /** + * CPC that the advertiser is targeting. + */ + targetCpcNanos?: string | null; + /** + * vCPM from Active View that the advertiser is targeting. + */ + targetCpmActiveViewNanos?: string | null; + /** + * CPM that the advertiser is targeting. + */ + targetCpmNanos?: string | null; + /** + * Number of impressions that the advertiser is targeting. + */ + targetImpressions?: string | null; + } + /** + * Project List Response + */ + export interface Schema$ProjectsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#projectsListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + /** + * Project collection. + */ + projects?: Schema$Project[]; + } + /** + * Represents fields that are compatible to be selected for a report of type "REACH". + */ + export interface Schema$ReachReportCompatibleFields { + /** + * Dimensions which are compatible to be selected in the "dimensionFilters" section of the report. + */ + dimensionFilters?: Schema$Dimension[]; + /** + * Dimensions which are compatible to be selected in the "dimensions" section of the report. + */ + dimensions?: Schema$Dimension[]; + /** + * The kind of resource this is, in this case dfareporting#reachReportCompatibleFields. + */ + kind?: string | null; + /** + * Metrics which are compatible to be selected in the "metricNames" section of the report. + */ + metrics?: Schema$Metric[]; + /** + * Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report. + */ + pivotedActivityMetrics?: Schema$Metric[]; + /** + * Metrics which are compatible to be selected in the "reachByFrequencyMetricNames" section of the report. + */ + reachByFrequencyMetrics?: Schema$Metric[]; + } + /** + * Represents a recipient. + */ + export interface Schema$Recipient { + /** + * The delivery type for the recipient. + */ + deliveryType?: string | null; + /** + * The email address of the recipient. + */ + email?: string | null; + /** + * The kind of resource this is, in this case dfareporting#recipient. + */ + kind?: string | null; + } + /** + * Contains information about a region that can be targeted by ads. + */ + export interface Schema$Region { + /** + * Country code of the country to which this region belongs. + */ + countryCode?: string | null; + /** + * DART ID of the country to which this region belongs. + */ + countryDartId?: string | null; + /** + * DART ID of this region. + */ + dartId?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#region". + */ + kind?: string | null; + /** + * Name of this region. + */ + name?: string | null; + /** + * Region code. + */ + regionCode?: string | null; + } + /** + * Region List Response + */ + export interface Schema$RegionsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#regionsListResponse". + */ + kind?: string | null; + /** + * Region collection. + */ + regions?: Schema$Region[]; + } + /** + * Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource. + */ + export interface Schema$RemarketingList { + /** + * Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. + */ + accountId?: string | null; + /** + * Whether this remarketing list is active. + */ + active?: boolean | null; + /** + * Dimension value for the advertiser ID that owns this remarketing list. This is a required field. + */ + advertiserId?: string | null; + /** + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Remarketing list description. + */ + description?: string | null; + /** + * Remarketing list ID. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList". + */ + kind?: string | null; + /** + * Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive. + */ + lifeSpan?: string | null; + /** + * Rule used to populate the remarketing list with users. + */ + listPopulationRule?: Schema$ListPopulationRule; + /** + * Number of users currently in the list. This is a read-only field. + */ + listSize?: string | null; + /** + * Product from which this remarketing list was originated. + */ + listSource?: string | null; + /** + * Name of the remarketing list. This is a required field. Must be no greater than 128 characters long. + */ + name?: string | null; + /** + * Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. + */ + subaccountId?: string | null; + } + /** + * Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers. + */ + export interface Schema$RemarketingListShare { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare". + */ + kind?: string | null; + /** + * Remarketing list ID. This is a read-only, auto-generated field. + */ + remarketingListId?: string | null; + /** + * Accounts that the remarketing list is shared with. + */ + sharedAccountIds?: string[] | null; + /** + * Advertisers that the remarketing list is shared with. + */ + sharedAdvertiserIds?: string[] | null; + } + /** + * Remarketing list response + */ + export interface Schema$RemarketingListsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListsListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + /** + * Remarketing list collection. + */ + remarketingLists?: Schema$RemarketingList[]; + } + /** + * Represents a Report resource. + */ + export interface Schema$Report { + /** + * The account ID to which this report belongs. + */ + accountId?: string | null; + /** + * The report criteria for a report of type "STANDARD". + */ + criteria?: { + activities?: Schema$Activities; + customRichMediaEvents?: Schema$CustomRichMediaEvents; + dateRange?: Schema$DateRange; + dimensionFilters?: Schema$DimensionValue[]; + dimensions?: Schema$SortedDimension[]; + metricNames?: string[]; + } | null; + /** + * The report criteria for a report of type "CROSS_DIMENSION_REACH". + */ + crossDimensionReachCriteria?: { + breakdown?: Schema$SortedDimension[]; + dateRange?: Schema$DateRange; + dimension?: string; + dimensionFilters?: Schema$DimensionValue[]; + metricNames?: string[]; + overlapMetricNames?: string[]; + pivoted?: boolean; + } | null; + /** + * The report's email delivery settings. + */ + delivery?: { + emailOwner?: boolean; + emailOwnerDeliveryType?: string; + message?: string; + recipients?: Schema$Recipient[]; + } | null; + /** + * The eTag of this response for caching purposes. + */ + etag?: string | null; + /** + * The filename used when generating report files for this report. + */ + fileName?: string | null; + /** + * The report criteria for a report of type "FLOODLIGHT". + */ + floodlightCriteria?: { + customRichMediaEvents?: Schema$DimensionValue[]; + dateRange?: Schema$DateRange; + dimensionFilters?: Schema$DimensionValue[]; + dimensions?: Schema$SortedDimension[]; + floodlightConfigId?: Schema$DimensionValue; + metricNames?: string[]; + reportProperties?: { + includeAttributedIPConversions?: boolean; + includeUnattributedCookieConversions?: boolean; + includeUnattributedIPConversions?: boolean; + }; + } | null; + /** + * The output format of the report. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format. + */ + format?: string | null; + /** + * The unique ID identifying this report resource. + */ + id?: string | null; + /** + * The kind of resource this is, in this case dfareporting#report. + */ + kind?: string | null; + /** + * The timestamp (in milliseconds since epoch) of when this report was last modified. + */ + lastModifiedTime?: string | null; + /** + * The name of the report. + */ + name?: string | null; + /** + * The user profile id of the owner of this report. + */ + ownerProfileId?: string | null; + /** + * The report criteria for a report of type "PATH_TO_CONVERSION". + */ + pathToConversionCriteria?: { + activityFilters?: Schema$DimensionValue[]; + conversionDimensions?: Schema$SortedDimension[]; + customFloodlightVariables?: Schema$SortedDimension[]; + customRichMediaEvents?: Schema$DimensionValue[]; + dateRange?: Schema$DateRange; + floodlightConfigId?: Schema$DimensionValue; + metricNames?: string[]; + perInteractionDimensions?: Schema$SortedDimension[]; + reportProperties?: { + clicksLookbackWindow?: number; + impressionsLookbackWindow?: number; + includeAttributedIPConversions?: boolean; + includeUnattributedCookieConversions?: boolean; + includeUnattributedIPConversions?: boolean; + maximumClickInteractions?: number; + maximumImpressionInteractions?: number; + maximumInteractionGap?: number; + pivotOnInteractionPath?: boolean; + }; + } | null; + /** + * The report criteria for a report of type "REACH". + */ + reachCriteria?: { + activities?: Schema$Activities; + customRichMediaEvents?: Schema$CustomRichMediaEvents; + dateRange?: Schema$DateRange; + dimensionFilters?: Schema$DimensionValue[]; + dimensions?: Schema$SortedDimension[]; + enableAllDimensionCombinations?: boolean; + metricNames?: string[]; + reachByFrequencyMetricNames?: string[]; + } | null; + /** + * The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY". + */ + schedule?: { + active?: boolean; + every?: number; + expirationDate?: string; + repeats?: string; + repeatsOnWeekDays?: string[]; + runsOnDayOfMonth?: string; + startDate?: string; + } | null; + /** + * The subaccount ID to which this report belongs if applicable. + */ + subAccountId?: string | null; + /** + * The type of the report. + */ + type?: string | null; + } + /** + * Represents fields that are compatible to be selected for a report of type "STANDARD". + */ + export interface Schema$ReportCompatibleFields { + /** + * Dimensions which are compatible to be selected in the "dimensionFilters" section of the report. + */ + dimensionFilters?: Schema$Dimension[]; + /** + * Dimensions which are compatible to be selected in the "dimensions" section of the report. + */ + dimensions?: Schema$Dimension[]; + /** + * The kind of resource this is, in this case dfareporting#reportCompatibleFields. + */ + kind?: string | null; + /** + * Metrics which are compatible to be selected in the "metricNames" section of the report. + */ + metrics?: Schema$Metric[]; + /** + * Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report. + */ + pivotedActivityMetrics?: Schema$Metric[]; + } + /** + * Represents the list of reports. + */ + export interface Schema$ReportList { + /** + * The eTag of this response for caching purposes. + */ + etag?: string | null; + /** + * The reports returned in this response. + */ + items?: Schema$Report[]; + /** + * The kind of list this is, in this case dfareporting#reportList. + */ + kind?: string | null; + /** + * Continuation token used to page through reports. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted. + */ + nextPageToken?: string | null; + } + /** + * Reporting Configuration + */ + export interface Schema$ReportsConfiguration { + /** + * Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting. + */ + exposureToConversionEnabled?: boolean | null; + /** + * Default lookback windows for new advertisers in this account. + */ + lookbackConfiguration?: Schema$LookbackConfiguration; + /** + * Report generation time zone ID of this account. This is a required field that can only be changed by a superuser. Acceptable values are: - "1" for "America/New_York" - "2" for "Europe/London" - "3" for "Europe/Paris" - "4" for "Africa/Johannesburg" - "5" for "Asia/Jerusalem" - "6" for "Asia/Shanghai" - "7" for "Asia/Hong_Kong" - "8" for "Asia/Tokyo" - "9" for "Australia/Sydney" - "10" for "Asia/Dubai" - "11" for "America/Los_Angeles" - "12" for "Pacific/Auckland" - "13" for "America/Sao_Paulo" - "16" for "America/Asuncion" - "17" for "America/Chicago" - "18" for "America/Denver" - "19" for "America/St_Johns" - "20" for "Asia/Dhaka" - "21" for "Asia/Jakarta" - "22" for "Asia/Kabul" - "23" for "Asia/Karachi" - "24" for "Asia/Calcutta" - "25" for "Asia/Pyongyang" - "26" for "Asia/Rangoon" - "27" for "Atlantic/Cape_Verde" - "28" for "Atlantic/South_Georgia" - "29" for "Australia/Adelaide" - "30" for "Australia/Lord_Howe" - "31" for "Europe/Moscow" - "32" for "Pacific/Kiritimati" - "35" for "Pacific/Norfolk" - "36" for "Pacific/Tongatapu" + */ + reportGenerationTimeZoneId?: string | null; + } + /** + * Rich Media Exit Override. + */ + export interface Schema$RichMediaExitOverride { + /** + * Click-through URL of this rich media exit override. Applicable if the enabled field is set to true. + */ + clickThroughUrl?: Schema$ClickThroughUrl; + /** + * Whether to use the clickThroughUrl. If false, the creative-level exit will be used. + */ + enabled?: boolean | null; + /** + * ID for the override to refer to a specific exit in the creative. + */ + exitId?: string | null; + } + /** + * A rule associates an asset with a targeting template for asset-level targeting. Applicable to INSTREAM_VIDEO creatives. + */ + export interface Schema$Rule { + /** + * A creativeAssets[].id. This should refer to one of the parent assets in this creative. This is a required field. + */ + assetId?: string | null; + /** + * A user-friendly name for this rule. This is a required field. + */ + name?: string | null; + /** + * A targeting template ID. The targeting from the targeting template will be used to determine whether this asset should be served. This is a required field. + */ + targetingTemplateId?: string | null; + } + /** + * Contains properties of a site. + */ + export interface Schema$Site { + /** + * Account ID of this site. This is a read-only field that can be left blank. + */ + accountId?: string | null; + /** + * Whether this site is approved. + */ + approved?: boolean | null; + /** + * Directory site associated with this site. This is a required field that is read-only after insertion. + */ + directorySiteId?: string | null; + /** + * Dimension value for the ID of the directory site. This is a read-only, auto-generated field. + */ + directorySiteIdDimensionValue?: Schema$DimensionValue; + /** + * ID of this site. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Dimension value for the ID of this site. This is a read-only, auto-generated field. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Key name of this site. This is a read-only, auto-generated field. + */ + keyName?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#site". + */ + kind?: string | null; + /** + * Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account. + */ + name?: string | null; + /** + * Site contacts. + */ + siteContacts?: Schema$SiteContact[]; + /** + * Site-wide settings. + */ + siteSettings?: Schema$SiteSettings; + /** + * Subaccount ID of this site. This is a read-only field that can be left blank. + */ + subaccountId?: string | null; + /** + * Default video settings for new placements created under this site. This value will be used to populate the placements.videoSettings field, when no value is specified for the new placement. + */ + videoSettings?: Schema$SiteVideoSettings; + } + /** + * Companion Settings + */ + export interface Schema$SiteCompanionSetting { + /** + * Whether companions are disabled for this site template. + */ + companionsDisabled?: boolean | null; + /** + * Whitelist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes. + */ + enabledSizes?: Schema$Size[]; + /** + * Whether to serve only static images as companions. + */ + imageOnly?: boolean | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting". + */ + kind?: string | null; + } + /** + * Site Contact + */ + export interface Schema$SiteContact { + /** + * Address of this site contact. + */ + address?: string | null; + /** + * Site contact type. + */ + contactType?: string | null; + /** + * Email address of this site contact. This is a required field. + */ + email?: string | null; + /** + * First name of this site contact. + */ + firstName?: string | null; + /** + * ID of this site contact. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Last name of this site contact. + */ + lastName?: string | null; + /** + * Primary phone number of this site contact. + */ + phone?: string | null; + /** + * Title or designation of this site contact. + */ + title?: string | null; + } + /** + * Site Settings + */ + export interface Schema$SiteSettings { + /** + * Whether active view creatives are disabled for this site. + */ + activeViewOptOut?: boolean | null; + /** + * Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect. + */ + adBlockingOptOut?: boolean | null; + /** + * Whether new cookies are disabled for this site. + */ + disableNewCookie?: boolean | null; + /** + * Configuration settings for dynamic and image floodlight tags. + */ + tagSetting?: Schema$TagSetting; + /** + * Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement. + */ + videoActiveViewOptOutTemplate?: boolean | null; + /** + * Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). Note: Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH. + */ + vpaidAdapterChoiceTemplate?: string | null; + } + /** + * Skippable Settings + */ + export interface Schema$SiteSkippableSetting { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting". + */ + kind?: string | null; + /** + * Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true. + */ + progressOffset?: Schema$VideoOffset; + /** + * Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true. + */ + skipOffset?: Schema$VideoOffset; + /** + * Whether the user can skip creatives served to this site. This will act as default for new placements created under this site. + */ + skippable?: boolean | null; + } + /** + * Site List Response + */ + export interface Schema$SitesListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#sitesListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + /** + * Site collection. + */ + sites?: Schema$Site[]; + } + /** + * Transcode Settings + */ + export interface Schema$SiteTranscodeSetting { + /** + * Whitelist of video formats to be served to this site template. Set this list to null or empty to serve all video formats. + */ + enabledVideoFormats?: number[] | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting". + */ + kind?: string | null; + } + /** + * Video Settings + */ + export interface Schema$SiteVideoSettings { + /** + * Settings for the companion creatives of video creatives served to this site. + */ + companionSettings?: Schema$SiteCompanionSetting; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings". + */ + kind?: string | null; + /** + * Orientation of a site template used for video. This will act as default for new placements created under this site. + */ + orientation?: string | null; + /** + * Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site. + */ + skippableSettings?: Schema$SiteSkippableSetting; + /** + * Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site. + */ + transcodeSettings?: Schema$SiteTranscodeSetting; + } + /** + * Represents the dimensions of ads, placements, creatives, or creative assets. + */ + export interface Schema$Size { + /** + * Height of this size. Acceptable values are 0 to 32767, inclusive. + */ + height?: number | null; + /** + * IAB standard size. This is a read-only, auto-generated field. + */ + iab?: boolean | null; + /** + * ID of this size. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". + */ + kind?: string | null; + /** + * Width of this size. Acceptable values are 0 to 32767, inclusive. + */ + width?: number | null; + } + /** + * Size List Response + */ + export interface Schema$SizesListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#sizesListResponse". + */ + kind?: string | null; + /** + * Size collection. + */ + sizes?: Schema$Size[]; + } + /** + * Skippable Settings + */ + export interface Schema$SkippableSetting { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting". + */ + kind?: string | null; + /** + * Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true. + */ + progressOffset?: Schema$VideoOffset; + /** + * Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true. + */ + skipOffset?: Schema$VideoOffset; + /** + * Whether the user can skip creatives served to this placement. + */ + skippable?: boolean | null; + } + /** + * Represents a sorted dimension. + */ + export interface Schema$SortedDimension { + /** + * The kind of resource this is, in this case dfareporting#sortedDimension. + */ + kind?: string | null; + /** + * The name of the dimension. + */ + name?: string | null; + /** + * An optional sort order for the dimension column. + */ + sortOrder?: string | null; + } + /** + * Contains properties of a Campaign Manager subaccount. + */ + export interface Schema$Subaccount { + /** + * ID of the account that contains this subaccount. This is a read-only field that can be left blank. + */ + accountId?: string | null; + /** + * IDs of the available user role permissions for this subaccount. + */ + availablePermissionIds?: string[] | null; + /** + * ID of this subaccount. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount". + */ + kind?: string | null; + /** + * Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account. + */ + name?: string | null; + } + /** + * Subaccount List Response + */ + export interface Schema$SubaccountsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccountsListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + /** + * Subaccount collection. + */ + subaccounts?: Schema$Subaccount[]; + } + /** + * Placement Tag Data + */ + export interface Schema$TagData { + /** + * Ad associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING. + */ + adId?: string | null; + /** + * Tag string to record a click. + */ + clickTag?: string | null; + /** + * Creative associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING. + */ + creativeId?: string | null; + /** + * TagData tag format of this tag. + */ + format?: string | null; + /** + * Tag string for serving an ad. + */ + impressionTag?: string | null; + } + /** + * Tag Settings + */ + export interface Schema$TagSetting { + /** + * Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field. + */ + additionalKeyValues?: string | null; + /** + * Whether static landing page URLs should be included in the tags. This setting applies only to placements. + */ + includeClickThroughUrls?: boolean | null; + /** + * Whether click-tracking string should be included in the tags. + */ + includeClickTracking?: boolean | null; + /** + * Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders. + */ + keywordOption?: string | null; + } + /** + * Dynamic and Image Tag Settings. + */ + export interface Schema$TagSettings { + /** + * Whether dynamic floodlight tags are enabled. + */ + dynamicTagEnabled?: boolean | null; + /** + * Whether image tags are enabled. + */ + imageTagEnabled?: boolean | null; + } + /** + * Contains properties of a targetable remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource is a read-only view of a remarketing list to be used to faciliate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource. + */ + export interface Schema$TargetableRemarketingList { + /** + * Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. + */ + accountId?: string | null; + /** + * Whether this targetable remarketing list is active. + */ + active?: boolean | null; + /** + * Dimension value for the advertiser ID that owns this targetable remarketing list. + */ + advertiserId?: string | null; + /** + * Dimension value for the ID of the advertiser. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Targetable remarketing list description. + */ + description?: string | null; + /** + * Targetable remarketing list ID. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingList". + */ + kind?: string | null; + /** + * Number of days that a user should remain in the targetable remarketing list without an impression. + */ + lifeSpan?: string | null; + /** + * Number of users currently in the list. This is a read-only field. + */ + listSize?: string | null; + /** + * Product from which this targetable remarketing list was originated. + */ + listSource?: string | null; + /** + * Name of the targetable remarketing list. Is no greater than 128 characters long. + */ + name?: string | null; + /** + * Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. + */ + subaccountId?: string | null; + } + /** + * Targetable remarketing list response + */ + export interface Schema$TargetableRemarketingListsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingListsListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + /** + * Targetable remarketing list collection. + */ + targetableRemarketingLists?: Schema$TargetableRemarketingList[]; + } + /** + * Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads. + */ + export interface Schema$TargetingTemplate { + /** + * Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. + */ + accountId?: string | null; + /** + * Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert. + */ + advertiserId?: string | null; + /** + * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Time and day targeting criteria. + */ + dayPartTargeting?: Schema$DayPartTargeting; + /** + * Geographical targeting criteria. + */ + geoTargeting?: Schema$GeoTargeting; + /** + * ID of this targeting template. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Key-value targeting criteria. + */ + keyValueTargetingExpression?: Schema$KeyValueTargetingExpression; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate". + */ + kind?: string | null; + /** + * Language targeting criteria. + */ + languageTargeting?: Schema$LanguageTargeting; + /** + * Remarketing list targeting criteria. + */ + listTargetingExpression?: Schema$ListTargetingExpression; + /** + * Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser. + */ + name?: string | null; + /** + * Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. + */ + subaccountId?: string | null; + /** + * Technology platform targeting criteria. + */ + technologyTargeting?: Schema$TechnologyTargeting; + } + /** + * Targeting Template List Response + */ + export interface Schema$TargetingTemplatesListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplatesListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + /** + * Targeting template collection. + */ + targetingTemplates?: Schema$TargetingTemplate[]; + } + /** + * Target Window. + */ + export interface Schema$TargetWindow { + /** + * User-entered value. + */ + customHtml?: string | null; + /** + * Type of browser window for which the backup image of the flash creative can be displayed. + */ + targetWindowOption?: string | null; + } + /** + * Technology Targeting. + */ + export interface Schema$TechnologyTargeting { + /** + * Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated. + */ + browsers?: Schema$Browser[]; + /** + * Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated. + */ + connectionTypes?: Schema$ConnectionType[]; + /** + * Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes. + */ + mobileCarriers?: Schema$MobileCarrier[]; + /** + * Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system. + */ + operatingSystems?: Schema$OperatingSystem[]; + /** + * Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems. + */ + operatingSystemVersions?: Schema$OperatingSystemVersion[]; + /** + * Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated. + */ + platformTypes?: Schema$PlatformType[]; + } + /** + * Third Party Authentication Token + */ + export interface Schema$ThirdPartyAuthenticationToken { + /** + * Name of the third-party authentication token. + */ + name?: string | null; + /** + * Value of the third-party authentication token. This is a read-only, auto-generated field. + */ + value?: string | null; + } + /** + * Third-party Tracking URL. + */ + export interface Schema$ThirdPartyTrackingUrl { + /** + * Third-party URL type for in-stream video and in-stream audio creatives. + */ + thirdPartyUrlType?: string | null; + /** + * URL for the specified third-party URL type. + */ + url?: string | null; + } + /** + * Transcode Settings + */ + export interface Schema$TranscodeSetting { + /** + * Whitelist of video formats to be served to this placement. Set this list to null or empty to serve all video formats. + */ + enabledVideoFormats?: number[] | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting". + */ + kind?: string | null; + } + /** + * A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID. + */ + export interface Schema$UniversalAdId { + /** + * Registry used for the Ad ID value. + */ + registry?: string | null; + /** + * ID value for this creative. Only alphanumeric characters and the following symbols are valid: "_/\-". Maximum length is 64 characters. Read only when registry is DCM. + */ + value?: string | null; + } + /** + * User Defined Variable configuration. + */ + export interface Schema$UserDefinedVariableConfiguration { + /** + * Data type for the variable. This is a required field. + */ + dataType?: string | null; + /** + * User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>". + */ + reportName?: string | null; + /** + * Variable name in the tag. This is a required field. + */ + variableType?: string | null; + } + /** + * Represents a UserProfile resource. + */ + export interface Schema$UserProfile { + /** + * The account ID to which this profile belongs. + */ + accountId?: string | null; + /** + * The account name this profile belongs to. + */ + accountName?: string | null; + /** + * The eTag of this response for caching purposes. + */ + etag?: string | null; + /** + * The kind of resource this is, in this case dfareporting#userProfile. + */ + kind?: string | null; + /** + * The unique ID of the user profile. + */ + profileId?: string | null; + /** + * The sub account ID this profile belongs to if applicable. + */ + subAccountId?: string | null; + /** + * The sub account name this profile belongs to if applicable. + */ + subAccountName?: string | null; + /** + * The user name. + */ + userName?: string | null; + } + /** + * Represents the list of user profiles. + */ + export interface Schema$UserProfileList { + /** + * The eTag of this response for caching purposes. + */ + etag?: string | null; + /** + * The user profiles returned in this response. + */ + items?: Schema$UserProfile[]; + /** + * The kind of list this is, in this case dfareporting#userProfileList. + */ + kind?: string | null; + } + /** + * Contains properties of auser role, which is used to manage user access. + */ + export interface Schema$UserRole { + /** + * Account ID of this user role. This is a read-only field that can be left blank. + */ + accountId?: string | null; + /** + * Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions. + */ + defaultUserRole?: boolean | null; + /** + * ID of this user role. This is a read-only, auto-generated field. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole". + */ + kind?: string | null; + /** + * Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account. + */ + name?: string | null; + /** + * ID of the user role that this user role is based on or copied from. This is a required field. + */ + parentUserRoleId?: string | null; + /** + * List of permissions associated with this user role. + */ + permissions?: Schema$UserRolePermission[]; + /** + * Subaccount ID of this user role. This is a read-only field that can be left blank. + */ + subaccountId?: string | null; + } + /** + * Contains properties of a user role permission. + */ + export interface Schema$UserRolePermission { + /** + * Levels of availability for a user role permission. + */ + availability?: string | null; + /** + * ID of this user role permission. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission". + */ + kind?: string | null; + /** + * Name of this user role permission. + */ + name?: string | null; + /** + * ID of the permission group that this user role permission belongs to. + */ + permissionGroupId?: string | null; + } + /** + * Represents a grouping of related user role permissions. + */ + export interface Schema$UserRolePermissionGroup { + /** + * ID of this user role permission. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroup". + */ + kind?: string | null; + /** + * Name of this user role permission group. + */ + name?: string | null; + } + /** + * User Role Permission Group List Response + */ + export interface Schema$UserRolePermissionGroupsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroupsListResponse". + */ + kind?: string | null; + /** + * User role permission group collection. + */ + userRolePermissionGroups?: Schema$UserRolePermissionGroup[]; + } + /** + * User Role Permission List Response + */ + export interface Schema$UserRolePermissionsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionsListResponse". + */ + kind?: string | null; + /** + * User role permission collection. + */ + userRolePermissions?: Schema$UserRolePermission[]; + } + /** + * User Role List Response + */ + export interface Schema$UserRolesListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolesListResponse". + */ + kind?: string | null; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string | null; + /** + * User role collection. + */ + userRoles?: Schema$UserRole[]; + } + /** + * Contains information about supported video formats. + */ + export interface Schema$VideoFormat { + /** + * File type of the video format. + */ + fileType?: string | null; + /** + * ID of the video format. + */ + id?: number | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoFormat". + */ + kind?: string | null; + /** + * The resolution of this video format. + */ + resolution?: Schema$Size; + /** + * The target bit rate of this video format. + */ + targetBitRate?: number | null; + } + /** + * Video Format List Response + */ + export interface Schema$VideoFormatsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoFormatsListResponse". + */ + kind?: string | null; + /** + * Video format collection. + */ + videoFormats?: Schema$VideoFormat[]; + } + /** + * Video Offset + */ + export interface Schema$VideoOffset { + /** + * Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. + */ + offsetPercentage?: number | null; + /** + * Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. + */ + offsetSeconds?: number | null; + } + /** + * Video Settings + */ + export interface Schema$VideoSettings { + /** + * Settings for the companion creatives of video creatives served to this placement. + */ + companionSettings?: Schema$CompanionSetting; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings". + */ + kind?: string | null; + /** + * Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. + */ + orientation?: string | null; + /** + * Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden. + */ + skippableSettings?: Schema$SkippableSetting; + /** + * Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden. + */ + transcodeSettings?: Schema$TranscodeSetting; + } + + export class Resource$Accountactiveadsummaries { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.accountActiveAdSummaries.get + * @desc Gets the account's active ad summary by account ID. + * @alias dfareporting.accountActiveAdSummaries.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {string} params.summaryAccountId Account ID. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Accountactiveadsummaries$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Accountactiveadsummaries$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Accountactiveadsummaries$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Accountactiveadsummaries$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accountactiveadsummaries$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accountactiveadsummaries$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'summaryAccountId'], + pathParams: ['profileId', 'summaryAccountId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Accountactiveadsummaries$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Account ID. + */ + summaryAccountId?: string; + } + + export class Resource$Accountpermissiongroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.accountPermissionGroups.get + * @desc Gets one account permission group by ID. + * @alias dfareporting.accountPermissionGroups.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Account permission group ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Accountpermissiongroups$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Accountpermissiongroups$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Accountpermissiongroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Accountpermissiongroups$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accountpermissiongroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accountpermissiongroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/accountPermissionGroups/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.accountPermissionGroups.list + * @desc Retrieves the list of account permission groups. + * @alias dfareporting.accountPermissionGroups.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Accountpermissiongroups$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Accountpermissiongroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Accountpermissiongroups$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Accountpermissiongroups$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$AccountPermissionGroupsListResponse + > + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accountpermissiongroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accountpermissiongroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/accountPermissionGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Accountpermissiongroups$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Account permission group ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Accountpermissiongroups$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Accountpermissions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.accountPermissions.get + * @desc Gets one account permission by ID. + * @alias dfareporting.accountPermissions.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Account permission ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Accountpermissions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Accountpermissions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Accountpermissions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Accountpermissions$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accountpermissions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accountpermissions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/accountPermissions/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.accountPermissions.list + * @desc Retrieves the list of account permissions. + * @alias dfareporting.accountPermissions.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Accountpermissions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Accountpermissions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Accountpermissions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Accountpermissions$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accountpermissions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accountpermissions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/accountPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Accountpermissions$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Account permission ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Accountpermissions$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Accounts { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.accounts.get + * @desc Gets one account by ID. + * @alias dfareporting.accounts.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Account ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Accounts$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Accounts$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Accounts$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Accounts$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Accounts$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/accounts/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.accounts.list + * @desc Retrieves the list of accounts, possibly filtered. This method supports paging. + * @alias dfareporting.accounts.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.active Select only active accounts. Don't set this field to select both active and non-active accounts. + * @param {string=} params.ids Select only accounts with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "account*2015" will return objects with names like "account June 2015", "account April 2015", or simply "account 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "account" will match objects with name "my account", "account 2015", or simply "account". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Accounts$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Accounts$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Accounts$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Accounts$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Accounts$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/accounts' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.accounts.patch + * @desc Updates an existing account. This method supports patch semantics. + * @alias dfareporting.accounts.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Account ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Account} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Accounts$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Accounts$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Accounts$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Accounts$Patch + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Accounts$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/accounts' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.accounts.update + * @desc Updates an existing account. + * @alias dfareporting.accounts.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Account} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Accounts$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Accounts$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Accounts$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Accounts$Update + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Accounts$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/accounts' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Accounts$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Account ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Accounts$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Select only active accounts. Don't set this field to select both active and non-active accounts. + */ + active?: boolean; + /** + * Select only accounts with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "account*2015" will return objects with names like "account June 2015", "account April 2015", or simply "account 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "account" will match objects with name "my account", "account 2015", or simply "account". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Accounts$Patch extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Account ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Account; + } + export interface Params$Resource$Accounts$Update extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Account; + } + + export class Resource$Accountuserprofiles { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.accountUserProfiles.get + * @desc Gets one account user profile by ID. + * @alias dfareporting.accountUserProfiles.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id User profile ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Accountuserprofiles$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Accountuserprofiles$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Accountuserprofiles$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Accountuserprofiles$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accountuserprofiles$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accountuserprofiles$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/accountUserProfiles/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.accountUserProfiles.insert + * @desc Inserts a new account user profile. + * @alias dfareporting.accountUserProfiles.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().AccountUserProfile} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Accountuserprofiles$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Accountuserprofiles$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Accountuserprofiles$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Accountuserprofiles$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accountuserprofiles$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accountuserprofiles$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/accountUserProfiles' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.accountUserProfiles.list + * @desc Retrieves a list of account user profiles, possibly filtered. This method supports paging. + * @alias dfareporting.accountUserProfiles.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.active Select only active user profiles. + * @param {string=} params.ids Select only user profiles with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "user profile*2015" will return objects with names like "user profile June 2015", "user profile April 2015", or simply "user profile 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "user profile" will match objects with name "my user profile", "user profile 2015", or simply "user profile". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {string=} params.subaccountId Select only user profiles with the specified subaccount ID. + * @param {string=} params.userRoleId Select only user profiles with the specified user role ID. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Accountuserprofiles$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Accountuserprofiles$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Accountuserprofiles$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Accountuserprofiles$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accountuserprofiles$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accountuserprofiles$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/accountUserProfiles' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * dfareporting.accountUserProfiles.patch + * @desc Updates an existing account user profile. This method supports patch semantics. + * @alias dfareporting.accountUserProfiles.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id User profile ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().AccountUserProfile} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Accountuserprofiles$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Accountuserprofiles$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Accountuserprofiles$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Accountuserprofiles$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accountuserprofiles$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accountuserprofiles$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/accountUserProfiles' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.accountUserProfiles.update + * @desc Updates an existing account user profile. + * @alias dfareporting.accountUserProfiles.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().AccountUserProfile} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Accountuserprofiles$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Accountuserprofiles$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Accountuserprofiles$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Accountuserprofiles$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accountuserprofiles$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accountuserprofiles$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/accountUserProfiles' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Accountuserprofiles$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Accountuserprofiles$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AccountUserProfile; + } + export interface Params$Resource$Accountuserprofiles$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Select only active user profiles. + */ + active?: boolean; + /** + * Select only user profiles with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "user profile*2015" will return objects with names like "user profile June 2015", "user profile April 2015", or simply "user profile 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "user profile" will match objects with name "my user profile", "user profile 2015", or simply "user profile". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + /** + * Select only user profiles with the specified subaccount ID. + */ + subaccountId?: string; + /** + * Select only user profiles with the specified user role ID. + */ + userRoleId?: string; + } + export interface Params$Resource$Accountuserprofiles$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AccountUserProfile; + } + export interface Params$Resource$Accountuserprofiles$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AccountUserProfile; + } + + export class Resource$Ads { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.ads.get + * @desc Gets one ad by ID. + * @alias dfareporting.ads.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Ad ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Ads$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Ads$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Ads$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Ads$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Ads$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Ads$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/ads/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.ads.insert + * @desc Inserts a new ad. + * @alias dfareporting.ads.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Ad} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Ads$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Ads$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Ads$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Ads$Insert + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Ads$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Ads$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/ads' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.ads.list + * @desc Retrieves a list of ads, possibly filtered. This method supports paging. + * @alias dfareporting.ads.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.active Select only active ads. + * @param {string=} params.advertiserId Select only ads with this advertiser ID. + * @param {boolean=} params.archived Select only archived ads. + * @param {string=} params.audienceSegmentIds Select only ads with these audience segment IDs. + * @param {string=} params.campaignIds Select only ads with these campaign IDs. + * @param {string=} params.compatibility Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard. + * @param {string=} params.creativeIds Select only ads with these creative IDs assigned. + * @param {string=} params.creativeOptimizationConfigurationIds Select only ads with these creative optimization configuration IDs. + * @param {boolean=} params.dynamicClickTracker Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both. + * @param {string=} params.ids Select only ads with these IDs. + * @param {string=} params.landingPageIds Select only ads with these landing page IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.overriddenEventTagId Select only ads with this event tag override ID. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string=} params.placementIds Select only ads with these placement IDs assigned. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.remarketingListIds Select only ads whose list targeting expression use these remarketing list IDs. + * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "ad*2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "ad" will match objects with name "my ad", "ad 2015", or simply "ad". + * @param {string=} params.sizeIds Select only ads with these size IDs. + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {boolean=} params.sslCompliant Select only ads that are SSL-compliant. + * @param {boolean=} params.sslRequired Select only ads that require SSL. + * @param {string=} params.type Select only ads with these types. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Ads$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Ads$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Ads$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Ads$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Ads$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Ads$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/ads' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.ads.patch + * @desc Updates an existing ad. This method supports patch semantics. + * @alias dfareporting.ads.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Ad ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Ad} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Ads$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Ads$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Ads$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Ads$Patch + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Ads$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Ads$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/ads' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.ads.update + * @desc Updates an existing ad. + * @alias dfareporting.ads.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Ad} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Ads$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Ads$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Ads$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Ads$Update + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Ads$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Ads$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/ads' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Ads$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Ad ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Ads$Insert extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Ad; + } + export interface Params$Resource$Ads$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Select only active ads. + */ + active?: boolean; + /** + * Select only ads with this advertiser ID. + */ + advertiserId?: string; + /** + * Select only archived ads. + */ + archived?: boolean; + /** + * Select only ads with these audience segment IDs. + */ + audienceSegmentIds?: string[]; + /** + * Select only ads with these campaign IDs. + */ + campaignIds?: string[]; + /** + * Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard. + */ + compatibility?: string; + /** + * Select only ads with these creative IDs assigned. + */ + creativeIds?: string[]; + /** + * Select only ads with these creative optimization configuration IDs. + */ + creativeOptimizationConfigurationIds?: string[]; + /** + * Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both. + */ + dynamicClickTracker?: boolean; + /** + * Select only ads with these IDs. + */ + ids?: string[]; + /** + * Select only ads with these landing page IDs. + */ + landingPageIds?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Select only ads with this event tag override ID. + */ + overriddenEventTagId?: string; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * Select only ads with these placement IDs assigned. + */ + placementIds?: string[]; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Select only ads whose list targeting expression use these remarketing list IDs. + */ + remarketingListIds?: string[]; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "ad*2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "ad" will match objects with name "my ad", "ad 2015", or simply "ad". + */ + searchString?: string; + /** + * Select only ads with these size IDs. + */ + sizeIds?: string[]; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + /** + * Select only ads that are SSL-compliant. + */ + sslCompliant?: boolean; + /** + * Select only ads that require SSL. + */ + sslRequired?: boolean; + /** + * Select only ads with these types. + */ + type?: string[]; + } + export interface Params$Resource$Ads$Patch extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Ad ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Ad; + } + export interface Params$Resource$Ads$Update extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Ad; + } + + export class Resource$Advertisergroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.advertiserGroups.delete + * @desc Deletes an existing advertiser group. + * @alias dfareporting.advertiserGroups.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Advertiser group ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Advertisergroups$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisergroups$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisergroups$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisergroups$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisergroups$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisergroups$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/advertiserGroups/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.advertiserGroups.get + * @desc Gets one advertiser group by ID. + * @alias dfareporting.advertiserGroups.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Advertiser group ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Advertisergroups$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisergroups$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisergroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisergroups$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisergroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisergroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/advertiserGroups/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.advertiserGroups.insert + * @desc Inserts a new advertiser group. + * @alias dfareporting.advertiserGroups.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().AdvertiserGroup} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Advertisergroups$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Advertisergroups$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Advertisergroups$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Advertisergroups$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisergroups$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisergroups$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/advertiserGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.advertiserGroups.list + * @desc Retrieves a list of advertiser groups, possibly filtered. This method supports paging. + * @alias dfareporting.advertiserGroups.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.ids Select only advertiser groups with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015", or simply "advertiser group 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015", or simply "advertisergroup". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Advertisergroups$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisergroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisergroups$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisergroups$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisergroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisergroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/advertiserGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * dfareporting.advertiserGroups.patch + * @desc Updates an existing advertiser group. This method supports patch semantics. + * @alias dfareporting.advertiserGroups.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Advertiser group ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().AdvertiserGroup} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Advertisergroups$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Advertisergroups$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisergroups$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Advertisergroups$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisergroups$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisergroups$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/advertiserGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.advertiserGroups.update + * @desc Updates an existing advertiser group. + * @alias dfareporting.advertiserGroups.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().AdvertiserGroup} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Advertisergroups$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Advertisergroups$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Advertisergroups$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Advertisergroups$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisergroups$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisergroups$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/advertiserGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisergroups$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Advertiser group ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Advertisergroups$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Advertiser group ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Advertisergroups$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AdvertiserGroup; + } + export interface Params$Resource$Advertisergroups$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Select only advertiser groups with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015", or simply "advertiser group 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015", or simply "advertisergroup". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Advertisergroups$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Advertiser group ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AdvertiserGroup; + } + export interface Params$Resource$Advertisergroups$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AdvertiserGroup; + } + + export class Resource$Advertiserlandingpages { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.advertiserLandingPages.get + * @desc Gets one landing page by ID. + * @alias dfareporting.advertiserLandingPages.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Landing page ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Advertiserlandingpages$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertiserlandingpages$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertiserlandingpages$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertiserlandingpages$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertiserlandingpages$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertiserlandingpages$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/advertiserLandingPages/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.advertiserLandingPages.insert + * @desc Inserts a new landing page. + * @alias dfareporting.advertiserLandingPages.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().LandingPage} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Advertiserlandingpages$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Advertiserlandingpages$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Advertiserlandingpages$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Advertiserlandingpages$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertiserlandingpages$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertiserlandingpages$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/advertiserLandingPages' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.advertiserLandingPages.list + * @desc Retrieves a list of landing pages. + * @alias dfareporting.advertiserLandingPages.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserIds Select only landing pages that belong to these advertisers. + * @param {boolean=} params.archived Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages. + * @param {string=} params.campaignIds Select only landing pages that are associated with these campaigns. + * @param {string=} params.ids Select only landing pages with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for landing pages by name or ID. Wildcards (*) are allowed. For example, "landingpage*2017" will return landing pages with names like "landingpage July 2017", "landingpage March 2017", or simply "landingpage 2017". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "landingpage" will match campaigns with name "my landingpage", "landingpage 2015", or simply "landingpage". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {string=} params.subaccountId Select only landing pages that belong to this subaccount. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Advertiserlandingpages$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertiserlandingpages$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertiserlandingpages$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Advertiserlandingpages$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertiserlandingpages$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertiserlandingpages$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/advertiserLandingPages' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * dfareporting.advertiserLandingPages.patch + * @desc Updates an existing landing page. This method supports patch semantics. + * @alias dfareporting.advertiserLandingPages.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Landing page ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().LandingPage} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Advertiserlandingpages$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Advertiserlandingpages$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertiserlandingpages$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Advertiserlandingpages$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertiserlandingpages$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertiserlandingpages$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/advertiserLandingPages' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.advertiserLandingPages.update + * @desc Updates an existing landing page. + * @alias dfareporting.advertiserLandingPages.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().LandingPage} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Advertiserlandingpages$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Advertiserlandingpages$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Advertiserlandingpages$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Advertiserlandingpages$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertiserlandingpages$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertiserlandingpages$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/advertiserLandingPages' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertiserlandingpages$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Landing page ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Advertiserlandingpages$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LandingPage; + } + export interface Params$Resource$Advertiserlandingpages$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Select only landing pages that belong to these advertisers. + */ + advertiserIds?: string[]; + /** + * Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages. + */ + archived?: boolean; + /** + * Select only landing pages that are associated with these campaigns. + */ + campaignIds?: string[]; + /** + * Select only landing pages with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for landing pages by name or ID. Wildcards (*) are allowed. For example, "landingpage*2017" will return landing pages with names like "landingpage July 2017", "landingpage March 2017", or simply "landingpage 2017". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "landingpage" will match campaigns with name "my landingpage", "landingpage 2015", or simply "landingpage". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + /** + * Select only landing pages that belong to this subaccount. + */ + subaccountId?: string; + } + export interface Params$Resource$Advertiserlandingpages$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Landing page ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LandingPage; + } + export interface Params$Resource$Advertiserlandingpages$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LandingPage; + } + + export class Resource$Advertisers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.advertisers.get + * @desc Gets one advertiser by ID. + * @alias dfareporting.advertisers.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Advertiser ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Advertisers$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Advertisers$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/advertisers/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.advertisers.insert + * @desc Inserts a new advertiser. + * @alias dfareporting.advertisers.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Advertiser} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Advertisers$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Advertisers$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Advertisers$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Advertisers$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/advertisers' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.advertisers.list + * @desc Retrieves a list of advertisers, possibly filtered. This method supports paging. + * @alias dfareporting.advertisers.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserGroupIds Select only advertisers with these advertiser group IDs. + * @param {string=} params.floodlightConfigurationIds Select only advertisers with these floodlight configuration IDs. + * @param {string=} params.ids Select only advertisers with these IDs. + * @param {boolean=} params.includeAdvertisersWithoutGroupsOnly Select only advertisers which do not belong to any advertiser group. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {boolean=} params.onlyParent Select only advertisers which use another advertiser's floodlight configuration. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser June 2015", "advertiser April 2015", or simply "advertiser 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertiser" will match objects with name "my advertiser", "advertiser 2015", or simply "advertiser". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {string=} params.status Select only advertisers with the specified status. + * @param {string=} params.subaccountId Select only advertisers with these subaccount IDs. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Advertisers$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Advertisers$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/advertisers' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.advertisers.patch + * @desc Updates an existing advertiser. This method supports patch semantics. + * @alias dfareporting.advertisers.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Advertiser ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Advertiser} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Advertisers$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Advertisers$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Advertisers$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/advertisers' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.advertisers.update + * @desc Updates an existing advertiser. + * @alias dfareporting.advertisers.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Advertiser} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Advertisers$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Advertisers$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Advertisers$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Advertisers$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/advertisers' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Advertiser ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Advertisers$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Advertiser; + } + export interface Params$Resource$Advertisers$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Select only advertisers with these advertiser group IDs. + */ + advertiserGroupIds?: string[]; + /** + * Select only advertisers with these floodlight configuration IDs. + */ + floodlightConfigurationIds?: string[]; + /** + * Select only advertisers with these IDs. + */ + ids?: string[]; + /** + * Select only advertisers which do not belong to any advertiser group. + */ + includeAdvertisersWithoutGroupsOnly?: boolean; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Select only advertisers which use another advertiser's floodlight configuration. + */ + onlyParent?: boolean; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser June 2015", "advertiser April 2015", or simply "advertiser 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertiser" will match objects with name "my advertiser", "advertiser 2015", or simply "advertiser". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + /** + * Select only advertisers with the specified status. + */ + status?: string; + /** + * Select only advertisers with these subaccount IDs. + */ + subaccountId?: string; + } + export interface Params$Resource$Advertisers$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Advertiser ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Advertiser; + } + export interface Params$Resource$Advertisers$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Advertiser; + } + + export class Resource$Browsers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.browsers.list + * @desc Retrieves a list of browsers. + * @alias dfareporting.browsers.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Browsers$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Browsers$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Browsers$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Browsers$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Browsers$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Browsers$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/browsers' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Browsers$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Campaigncreativeassociations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.campaignCreativeAssociations.insert + * @desc Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already. + * @alias dfareporting.campaignCreativeAssociations.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.campaignId Campaign ID in this association. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().CampaignCreativeAssociation} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Campaigncreativeassociations$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Campaigncreativeassociations$Insert, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Campaigncreativeassociations$Insert, + callback: BodyResponseCallback + ): void; + insert( + callback: BodyResponseCallback + ): void; + insert( + paramsOrCallback?: + | Params$Resource$Campaigncreativeassociations$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Campaigncreativeassociations$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Campaigncreativeassociations$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['profileId', 'campaignId'], + pathParams: ['campaignId', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.campaignCreativeAssociations.list + * @desc Retrieves the list of creative IDs associated with the specified campaign. This method supports paging. + * @alias dfareporting.campaignCreativeAssociations.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.campaignId Campaign ID in this association. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Campaigncreativeassociations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Campaigncreativeassociations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback< + Schema$CampaignCreativeAssociationsListResponse + > + ): void; + list( + params: Params$Resource$Campaigncreativeassociations$List, + callback: BodyResponseCallback< + Schema$CampaignCreativeAssociationsListResponse + > + ): void; + list( + callback: BodyResponseCallback< + Schema$CampaignCreativeAssociationsListResponse + > + ): void; + list( + paramsOrCallback?: + | Params$Resource$Campaigncreativeassociations$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$CampaignCreativeAssociationsListResponse + > + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Campaigncreativeassociations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Campaigncreativeassociations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'campaignId'], + pathParams: ['campaignId', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest< + Schema$CampaignCreativeAssociationsListResponse + >(parameters); + } + } + } + + export interface Params$Resource$Campaigncreativeassociations$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Campaign ID in this association. + */ + campaignId?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CampaignCreativeAssociation; + } + export interface Params$Resource$Campaigncreativeassociations$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Campaign ID in this association. + */ + campaignId?: string; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + + export class Resource$Campaigns { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.campaigns.get + * @desc Gets one campaign by ID. + * @alias dfareporting.campaigns.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Campaign ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Campaigns$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Campaigns$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Campaigns$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Campaigns$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Campaigns$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Campaigns$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/campaigns/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.campaigns.insert + * @desc Inserts a new campaign. + * @alias dfareporting.campaigns.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Campaign} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Campaigns$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Campaigns$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Campaigns$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Campaigns$Insert + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Campaigns$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Campaigns$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/campaigns' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.campaigns.list + * @desc Retrieves a list of campaigns, possibly filtered. This method supports paging. + * @alias dfareporting.campaigns.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserGroupIds Select only campaigns whose advertisers belong to these advertiser groups. + * @param {string=} params.advertiserIds Select only campaigns that belong to these advertisers. + * @param {boolean=} params.archived Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns. + * @param {boolean=} params.atLeastOneOptimizationActivity Select only campaigns that have at least one optimization activity. + * @param {string=} params.excludedIds Exclude campaigns with these IDs. + * @param {string=} params.ids Select only campaigns with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.overriddenEventTagId Select only campaigns that have overridden this event tag ID. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, "campaign*2015" will return campaigns with names like "campaign June 2015", "campaign April 2015", or simply "campaign 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "campaign" will match campaigns with name "my campaign", "campaign 2015", or simply "campaign". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {string=} params.subaccountId Select only campaigns that belong to this subaccount. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Campaigns$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Campaigns$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Campaigns$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Campaigns$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Campaigns$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Campaigns$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/campaigns' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.campaigns.patch + * @desc Updates an existing campaign. This method supports patch semantics. + * @alias dfareporting.campaigns.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Campaign ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Campaign} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Campaigns$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Campaigns$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Campaigns$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Campaigns$Patch + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Campaigns$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Campaigns$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/campaigns' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.campaigns.update + * @desc Updates an existing campaign. + * @alias dfareporting.campaigns.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Campaign} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Campaigns$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Campaigns$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Campaigns$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Campaigns$Update + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Campaigns$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Campaigns$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/campaigns' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Campaigns$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Campaign ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Campaigns$Insert extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Campaign; + } + export interface Params$Resource$Campaigns$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Select only campaigns whose advertisers belong to these advertiser groups. + */ + advertiserGroupIds?: string[]; + /** + * Select only campaigns that belong to these advertisers. + */ + advertiserIds?: string[]; + /** + * Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns. + */ + archived?: boolean; + /** + * Select only campaigns that have at least one optimization activity. + */ + atLeastOneOptimizationActivity?: boolean; + /** + * Exclude campaigns with these IDs. + */ + excludedIds?: string[]; + /** + * Select only campaigns with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Select only campaigns that have overridden this event tag ID. + */ + overriddenEventTagId?: string; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, "campaign*2015" will return campaigns with names like "campaign June 2015", "campaign April 2015", or simply "campaign 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "campaign" will match campaigns with name "my campaign", "campaign 2015", or simply "campaign". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + /** + * Select only campaigns that belong to this subaccount. + */ + subaccountId?: string; + } + export interface Params$Resource$Campaigns$Patch extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Campaign ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Campaign; + } + export interface Params$Resource$Campaigns$Update extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Campaign; + } + + export class Resource$Changelogs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.changeLogs.get + * @desc Gets one change log by ID. + * @alias dfareporting.changeLogs.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Change log ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Changelogs$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Changelogs$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Changelogs$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Changelogs$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Changelogs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Changelogs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/changeLogs/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.changeLogs.list + * @desc Retrieves a list of change logs. This method supports paging. + * @alias dfareporting.changeLogs.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.action Select only change logs with the specified action. + * @param {string=} params.ids Select only change logs with these IDs. + * @param {string=} params.maxChangeTime Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.minChangeTime Select only change logs whose change time is after the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset. + * @param {string=} params.objectIds Select only change logs with these object IDs. + * @param {string=} params.objectType Select only change logs with the specified object type. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Select only change logs whose object ID, user name, old or new values match the search string. + * @param {string=} params.userProfileIds Select only change logs with these user profile IDs. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Changelogs$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Changelogs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Changelogs$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Changelogs$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Changelogs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Changelogs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/changeLogs' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Changelogs$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Change log ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Changelogs$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Select only change logs with the specified action. + */ + action?: string; + /** + * Select only change logs with these IDs. + */ + ids?: string[]; + /** + * Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset. + */ + maxChangeTime?: string; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Select only change logs whose change time is after the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset. + */ + minChangeTime?: string; + /** + * Select only change logs with these object IDs. + */ + objectIds?: string[]; + /** + * Select only change logs with the specified object type. + */ + objectType?: string; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Select only change logs whose object ID, user name, old or new values match the search string. + */ + searchString?: string; + /** + * Select only change logs with these user profile IDs. + */ + userProfileIds?: string[]; + } + + export class Resource$Cities { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.cities.list + * @desc Retrieves a list of cities, possibly filtered. + * @alias dfareporting.cities.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.countryDartIds Select only cities from these countries. + * @param {string=} params.dartIds Select only cities with these DART IDs. + * @param {string=} params.namePrefix Select only cities with names starting with this prefix. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.regionDartIds Select only cities from these regions. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Cities$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Cities$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Cities$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Cities$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Cities$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Cities$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/cities' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Cities$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Select only cities from these countries. + */ + countryDartIds?: string[]; + /** + * Select only cities with these DART IDs. + */ + dartIds?: string[]; + /** + * Select only cities with names starting with this prefix. + */ + namePrefix?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Select only cities from these regions. + */ + regionDartIds?: string[]; + } + + export class Resource$Connectiontypes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.connectionTypes.get + * @desc Gets one connection type by ID. + * @alias dfareporting.connectionTypes.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Connection type ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Connectiontypes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Connectiontypes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Connectiontypes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Connectiontypes$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Connectiontypes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Connectiontypes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/connectionTypes/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.connectionTypes.list + * @desc Retrieves a list of connection types. + * @alias dfareporting.connectionTypes.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Connectiontypes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Connectiontypes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Connectiontypes$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Connectiontypes$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Connectiontypes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Connectiontypes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/connectionTypes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Connectiontypes$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Connection type ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Connectiontypes$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Contentcategories { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.contentCategories.delete + * @desc Deletes an existing content category. + * @alias dfareporting.contentCategories.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Content category ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Contentcategories$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Contentcategories$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Contentcategories$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Contentcategories$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Contentcategories$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Contentcategories$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/contentCategories/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.contentCategories.get + * @desc Gets one content category by ID. + * @alias dfareporting.contentCategories.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Content category ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Contentcategories$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Contentcategories$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Contentcategories$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Contentcategories$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Contentcategories$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Contentcategories$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/contentCategories/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.contentCategories.insert + * @desc Inserts a new content category. + * @alias dfareporting.contentCategories.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().ContentCategory} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Contentcategories$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Contentcategories$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Contentcategories$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Contentcategories$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Contentcategories$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Contentcategories$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/contentCategories' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.contentCategories.list + * @desc Retrieves a list of content categories, possibly filtered. This method supports paging. + * @alias dfareporting.contentCategories.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.ids Select only content categories with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "contentcategory*2015" will return objects with names like "contentcategory June 2015", "contentcategory April 2015", or simply "contentcategory 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "contentcategory" will match objects with name "my contentcategory", "contentcategory 2015", or simply "contentcategory". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Contentcategories$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Contentcategories$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Contentcategories$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Contentcategories$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Contentcategories$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Contentcategories$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/contentCategories' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * dfareporting.contentCategories.patch + * @desc Updates an existing content category. This method supports patch semantics. + * @alias dfareporting.contentCategories.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Content category ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().ContentCategory} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Contentcategories$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Contentcategories$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Contentcategories$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Contentcategories$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Contentcategories$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Contentcategories$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/contentCategories' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.contentCategories.update + * @desc Updates an existing content category. + * @alias dfareporting.contentCategories.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().ContentCategory} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Contentcategories$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Contentcategories$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Contentcategories$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Contentcategories$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Contentcategories$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Contentcategories$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/contentCategories' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Contentcategories$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Content category ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Contentcategories$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Content category ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Contentcategories$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ContentCategory; + } + export interface Params$Resource$Contentcategories$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Select only content categories with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "contentcategory*2015" will return objects with names like "contentcategory June 2015", "contentcategory April 2015", or simply "contentcategory 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "contentcategory" will match objects with name "my contentcategory", "contentcategory 2015", or simply "contentcategory". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Contentcategories$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Content category ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ContentCategory; + } + export interface Params$Resource$Contentcategories$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ContentCategory; + } + + export class Resource$Conversions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.conversions.batchinsert + * @desc Inserts conversions. + * @alias dfareporting.conversions.batchinsert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().ConversionsBatchInsertRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + batchinsert( + params?: Params$Resource$Conversions$Batchinsert, + options?: MethodOptions + ): GaxiosPromise; + batchinsert( + params: Params$Resource$Conversions$Batchinsert, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchinsert( + params: Params$Resource$Conversions$Batchinsert, + callback: BodyResponseCallback + ): void; + batchinsert( + callback: BodyResponseCallback + ): void; + batchinsert( + paramsOrCallback?: + | Params$Resource$Conversions$Batchinsert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Conversions$Batchinsert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Conversions$Batchinsert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/conversions/batchinsert' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * dfareporting.conversions.batchupdate + * @desc Updates existing conversions. + * @alias dfareporting.conversions.batchupdate + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().ConversionsBatchUpdateRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + batchupdate( + params?: Params$Resource$Conversions$Batchupdate, + options?: MethodOptions + ): GaxiosPromise; + batchupdate( + params: Params$Resource$Conversions$Batchupdate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchupdate( + params: Params$Resource$Conversions$Batchupdate, + callback: BodyResponseCallback + ): void; + batchupdate( + callback: BodyResponseCallback + ): void; + batchupdate( + paramsOrCallback?: + | Params$Resource$Conversions$Batchupdate + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Conversions$Batchupdate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Conversions$Batchupdate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/conversions/batchupdate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Conversions$Batchinsert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ConversionsBatchInsertRequest; + } + export interface Params$Resource$Conversions$Batchupdate + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ConversionsBatchUpdateRequest; + } + + export class Resource$Countries { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.countries.get + * @desc Gets one country by ID. + * @alias dfareporting.countries.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.dartId Country DART ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Countries$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Countries$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Countries$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Countries$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Countries$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Countries$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/countries/{dartId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'dartId'], + pathParams: ['dartId', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.countries.list + * @desc Retrieves a list of countries. + * @alias dfareporting.countries.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Countries$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Countries$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Countries$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Countries$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Countries$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Countries$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/countries' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Countries$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Country DART ID. + */ + dartId?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Countries$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Creativeassets { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.creativeAssets.insert + * @desc Inserts a new creative asset. + * @alias dfareporting.creativeAssets.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Advertiser ID of this creative. This is a required field. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} params.requestBody Media resource metadata + * @param {object} params.media Media object + * @param {string} params.media.mimeType Media mime-type + * @param {string|object} params.media.body Media body contents + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Creativeassets$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Creativeassets$Insert, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Creativeassets$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Creativeassets$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Creativeassets$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativeassets$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + mediaUrl: ( + rootUrl + + '/upload/dfareporting/v3.3/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets' + ).replace(/([^:]\/)\/+/g, '$1'), + requiredParams: ['profileId', 'advertiserId'], + pathParams: ['advertiserId', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Creativeassets$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Advertiser ID of this creative. This is a required field. + */ + advertiserId?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreativeAssetMetadata; + + /** + * Media metadata + */ + media?: { + /** + * Media mime-type + */ + mimeType?: string; + + /** + * Media body contents + */ + body?: any; + }; + } + + export class Resource$Creativefields { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.creativeFields.delete + * @desc Deletes an existing creative field. + * @alias dfareporting.creativeFields.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Creative Field ID + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Creativefields$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Creativefields$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Creativefields$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Creativefields$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Creativefields$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativefields$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creativeFields/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.creativeFields.get + * @desc Gets one creative field by ID. + * @alias dfareporting.creativeFields.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Creative Field ID + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Creativefields$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Creativefields$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Creativefields$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Creativefields$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Creativefields$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativefields$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creativeFields/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.creativeFields.insert + * @desc Inserts a new creative field. + * @alias dfareporting.creativeFields.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().CreativeField} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Creativefields$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Creativefields$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Creativefields$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Creativefields$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Creativefields$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativefields$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creativeFields' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.creativeFields.list + * @desc Retrieves a list of creative fields, possibly filtered. This method supports paging. + * @alias dfareporting.creativeFields.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserIds Select only creative fields that belong to these advertisers. + * @param {string=} params.ids Select only creative fields with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, "creativefield*2015" will return creative fields with names like "creativefield June 2015", "creativefield April 2015", or simply "creativefield 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativefield" will match creative fields with the name "my creativefield", "creativefield 2015", or simply "creativefield". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Creativefields$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Creativefields$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Creativefields$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Creativefields$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Creativefields$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativefields$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creativeFields' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.creativeFields.patch + * @desc Updates an existing creative field. This method supports patch semantics. + * @alias dfareporting.creativeFields.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Creative Field ID + * @param {string} params.profileId User profile ID associated with this request. + * @param {().CreativeField} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Creativefields$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Creativefields$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Creativefields$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Creativefields$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Creativefields$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativefields$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creativeFields' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.creativeFields.update + * @desc Updates an existing creative field. + * @alias dfareporting.creativeFields.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().CreativeField} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Creativefields$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Creativefields$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Creativefields$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Creativefields$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Creativefields$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativefields$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creativeFields' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Creativefields$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Creative Field ID + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Creativefields$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Creative Field ID + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Creativefields$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreativeField; + } + export interface Params$Resource$Creativefields$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Select only creative fields that belong to these advertisers. + */ + advertiserIds?: string[]; + /** + * Select only creative fields with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, "creativefield*2015" will return creative fields with names like "creativefield June 2015", "creativefield April 2015", or simply "creativefield 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativefield" will match creative fields with the name "my creativefield", "creativefield 2015", or simply "creativefield". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Creativefields$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Creative Field ID + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreativeField; + } + export interface Params$Resource$Creativefields$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreativeField; + } + + export class Resource$Creativefieldvalues { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.creativeFieldValues.delete + * @desc Deletes an existing creative field value. + * @alias dfareporting.creativeFieldValues.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.creativeFieldId Creative field ID for this creative field value. + * @param {string} params.id Creative Field Value ID + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Creativefieldvalues$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Creativefieldvalues$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Creativefieldvalues$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Creativefieldvalues$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Creativefieldvalues$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativefieldvalues$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['profileId', 'creativeFieldId', 'id'], + pathParams: ['creativeFieldId', 'id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.creativeFieldValues.get + * @desc Gets one creative field value by ID. + * @alias dfareporting.creativeFieldValues.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.creativeFieldId Creative field ID for this creative field value. + * @param {string} params.id Creative Field Value ID + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Creativefieldvalues$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Creativefieldvalues$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Creativefieldvalues$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Creativefieldvalues$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Creativefieldvalues$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativefieldvalues$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'creativeFieldId', 'id'], + pathParams: ['creativeFieldId', 'id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.creativeFieldValues.insert + * @desc Inserts a new creative field value. + * @alias dfareporting.creativeFieldValues.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.creativeFieldId Creative field ID for this creative field value. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().CreativeFieldValue} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Creativefieldvalues$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Creativefieldvalues$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Creativefieldvalues$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Creativefieldvalues$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Creativefieldvalues$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativefieldvalues$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['profileId', 'creativeFieldId'], + pathParams: ['creativeFieldId', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.creativeFieldValues.list + * @desc Retrieves a list of creative field values, possibly filtered. This method supports paging. + * @alias dfareporting.creativeFieldValues.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.creativeFieldId Creative field ID for this creative field value. + * @param {string=} params.ids Select only creative field values with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed. + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Creativefieldvalues$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Creativefieldvalues$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Creativefieldvalues$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Creativefieldvalues$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Creativefieldvalues$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativefieldvalues$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'creativeFieldId'], + pathParams: ['creativeFieldId', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * dfareporting.creativeFieldValues.patch + * @desc Updates an existing creative field value. This method supports patch semantics. + * @alias dfareporting.creativeFieldValues.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.creativeFieldId Creative field ID for this creative field value. + * @param {string} params.id Creative Field Value ID + * @param {string} params.profileId User profile ID associated with this request. + * @param {().CreativeFieldValue} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Creativefieldvalues$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Creativefieldvalues$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Creativefieldvalues$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Creativefieldvalues$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Creativefieldvalues$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativefieldvalues$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['profileId', 'creativeFieldId', 'id'], + pathParams: ['creativeFieldId', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.creativeFieldValues.update + * @desc Updates an existing creative field value. + * @alias dfareporting.creativeFieldValues.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.creativeFieldId Creative field ID for this creative field value. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().CreativeFieldValue} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Creativefieldvalues$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Creativefieldvalues$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Creativefieldvalues$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Creativefieldvalues$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Creativefieldvalues$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativefieldvalues$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['profileId', 'creativeFieldId'], + pathParams: ['creativeFieldId', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Creativefieldvalues$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Creative field ID for this creative field value. + */ + creativeFieldId?: string; + /** + * Creative Field Value ID + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Creativefieldvalues$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Creative field ID for this creative field value. + */ + creativeFieldId?: string; + /** + * Creative Field Value ID + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Creativefieldvalues$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Creative field ID for this creative field value. + */ + creativeFieldId?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreativeFieldValue; + } + export interface Params$Resource$Creativefieldvalues$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Creative field ID for this creative field value. + */ + creativeFieldId?: string; + /** + * Select only creative field values with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed. + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Creativefieldvalues$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Creative field ID for this creative field value. + */ + creativeFieldId?: string; + /** + * Creative Field Value ID + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreativeFieldValue; + } + export interface Params$Resource$Creativefieldvalues$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Creative field ID for this creative field value. + */ + creativeFieldId?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreativeFieldValue; + } + + export class Resource$Creativegroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.creativeGroups.get + * @desc Gets one creative group by ID. + * @alias dfareporting.creativeGroups.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Creative group ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Creativegroups$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Creativegroups$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Creativegroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Creativegroups$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Creativegroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativegroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creativeGroups/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.creativeGroups.insert + * @desc Inserts a new creative group. + * @alias dfareporting.creativeGroups.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().CreativeGroup} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Creativegroups$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Creativegroups$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Creativegroups$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Creativegroups$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Creativegroups$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativegroups$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creativeGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.creativeGroups.list + * @desc Retrieves a list of creative groups, possibly filtered. This method supports paging. + * @alias dfareporting.creativeGroups.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserIds Select only creative groups that belong to these advertisers. + * @param {integer=} params.groupNumber Select only creative groups that belong to this subgroup. + * @param {string=} params.ids Select only creative groups with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, "creativegroup*2015" will return creative groups with names like "creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015", or simply "creativegroup". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Creativegroups$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Creativegroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Creativegroups$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Creativegroups$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Creativegroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativegroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creativeGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.creativeGroups.patch + * @desc Updates an existing creative group. This method supports patch semantics. + * @alias dfareporting.creativeGroups.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Creative group ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().CreativeGroup} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Creativegroups$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Creativegroups$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Creativegroups$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Creativegroups$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Creativegroups$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativegroups$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creativeGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.creativeGroups.update + * @desc Updates an existing creative group. + * @alias dfareporting.creativeGroups.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().CreativeGroup} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Creativegroups$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Creativegroups$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Creativegroups$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Creativegroups$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Creativegroups$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativegroups$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creativeGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Creativegroups$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Creative group ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Creativegroups$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreativeGroup; + } + export interface Params$Resource$Creativegroups$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Select only creative groups that belong to these advertisers. + */ + advertiserIds?: string[]; + /** + * Select only creative groups that belong to this subgroup. + */ + groupNumber?: number; + /** + * Select only creative groups with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, "creativegroup*2015" will return creative groups with names like "creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015", or simply "creativegroup". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Creativegroups$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Creative group ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreativeGroup; + } + export interface Params$Resource$Creativegroups$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreativeGroup; + } + + export class Resource$Creatives { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.creatives.get + * @desc Gets one creative by ID. + * @alias dfareporting.creatives.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Creative ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Creatives$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Creatives$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Creatives$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Creatives$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Creatives$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creatives$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creatives/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.creatives.insert + * @desc Inserts a new creative. + * @alias dfareporting.creatives.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Creative} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Creatives$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Creatives$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Creatives$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Creatives$Insert + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Creatives$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creatives$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/creatives' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.creatives.list + * @desc Retrieves a list of creatives, possibly filtered. This method supports paging. + * @alias dfareporting.creatives.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.active Select only active creatives. Leave blank to select active and inactive creatives. + * @param {string=} params.advertiserId Select only creatives with this advertiser ID. + * @param {boolean=} params.archived Select only archived creatives. Leave blank to select archived and unarchived creatives. + * @param {string=} params.campaignId Select only creatives with this campaign ID. + * @param {string=} params.companionCreativeIds Select only in-stream video creatives with these companion IDs. + * @param {string=} params.creativeFieldIds Select only creatives with these creative field IDs. + * @param {string=} params.ids Select only creatives with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.renderingIds Select only creatives with these rendering IDs. + * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "creative*2015" will return objects with names like "creative June 2015", "creative April 2015", or simply "creative 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "creative" will match objects with name "my creative", "creative 2015", or simply "creative". + * @param {string=} params.sizeIds Select only creatives with these size IDs. + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {string=} params.studioCreativeId Select only creatives corresponding to this Studio creative ID. + * @param {string=} params.types Select only creatives with these creative types. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Creatives$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Creatives$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Creatives$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Creatives$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Creatives$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creatives$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/creatives' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.creatives.patch + * @desc Updates an existing creative. This method supports patch semantics. + * @alias dfareporting.creatives.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Creative ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Creative} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Creatives$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Creatives$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Creatives$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Creatives$Patch + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Creatives$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creatives$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/creatives' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.creatives.update + * @desc Updates an existing creative. + * @alias dfareporting.creatives.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Creative} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Creatives$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Creatives$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Creatives$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Creatives$Update + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Creatives$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creatives$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/creatives' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Creatives$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Creative ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Creatives$Insert extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Creative; + } + export interface Params$Resource$Creatives$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Select only active creatives. Leave blank to select active and inactive creatives. + */ + active?: boolean; + /** + * Select only creatives with this advertiser ID. + */ + advertiserId?: string; + /** + * Select only archived creatives. Leave blank to select archived and unarchived creatives. + */ + archived?: boolean; + /** + * Select only creatives with this campaign ID. + */ + campaignId?: string; + /** + * Select only in-stream video creatives with these companion IDs. + */ + companionCreativeIds?: string[]; + /** + * Select only creatives with these creative field IDs. + */ + creativeFieldIds?: string[]; + /** + * Select only creatives with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Select only creatives with these rendering IDs. + */ + renderingIds?: string[]; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "creative*2015" will return objects with names like "creative June 2015", "creative April 2015", or simply "creative 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "creative" will match objects with name "my creative", "creative 2015", or simply "creative". + */ + searchString?: string; + /** + * Select only creatives with these size IDs. + */ + sizeIds?: string[]; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + /** + * Select only creatives corresponding to this Studio creative ID. + */ + studioCreativeId?: string; + /** + * Select only creatives with these creative types. + */ + types?: string[]; + } + export interface Params$Resource$Creatives$Patch extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Creative ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Creative; + } + export interface Params$Resource$Creatives$Update extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Creative; + } + + export class Resource$Dimensionvalues { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.dimensionValues.query + * @desc Retrieves list of report dimension values for a list of filters. + * @alias dfareporting.dimensionValues.query + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken The value of the nextToken from the previous result page. + * @param {string} params.profileId The DFA user profile ID. + * @param {().DimensionValueRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + query( + params?: Params$Resource$Dimensionvalues$Query, + options?: MethodOptions + ): GaxiosPromise; + query( + params: Params$Resource$Dimensionvalues$Query, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + query( + params: Params$Resource$Dimensionvalues$Query, + callback: BodyResponseCallback + ): void; + query(callback: BodyResponseCallback): void; + query( + paramsOrCallback?: + | Params$Resource$Dimensionvalues$Query + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Dimensionvalues$Query; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Dimensionvalues$Query; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/dimensionvalues/query' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Dimensionvalues$Query + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * The value of the nextToken from the previous result page. + */ + pageToken?: string; + /** + * The DFA user profile ID. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DimensionValueRequest; + } + + export class Resource$Directorysites { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.directorySites.get + * @desc Gets one directory site by ID. + * @alias dfareporting.directorySites.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Directory site ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Directorysites$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Directorysites$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Directorysites$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Directorysites$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Directorysites$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Directorysites$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/directorySites/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.directorySites.insert + * @desc Inserts a new directory site. + * @alias dfareporting.directorySites.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().DirectorySite} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Directorysites$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Directorysites$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Directorysites$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Directorysites$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Directorysites$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Directorysites$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/directorySites' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.directorySites.list + * @desc Retrieves a list of directory sites, possibly filtered. This method supports paging. + * @alias dfareporting.directorySites.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.acceptsInStreamVideoPlacements This search filter is no longer supported and will have no effect on the results returned. + * @param {boolean=} params.acceptsInterstitialPlacements This search filter is no longer supported and will have no effect on the results returned. + * @param {boolean=} params.acceptsPublisherPaidPlacements Select only directory sites that accept publisher paid placements. This field can be left blank. + * @param {boolean=} params.active Select only active directory sites. Leave blank to retrieve both active and inactive directory sites. + * @param {string=} params.dfpNetworkCode Select only directory sites with this Ad Manager network code. + * @param {string=} params.ids Select only directory sites with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, "directory site*2015" will return objects with names like "directory site June 2015", "directory site April 2015", or simply "directory site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site" will match objects with name "my directory site", "directory site 2015" or simply, "directory site". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Directorysites$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Directorysites$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Directorysites$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Directorysites$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Directorysites$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Directorysites$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/directorySites' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Directorysites$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Directory site ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Directorysites$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DirectorySite; + } + export interface Params$Resource$Directorysites$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * This search filter is no longer supported and will have no effect on the results returned. + */ + acceptsInStreamVideoPlacements?: boolean; + /** + * This search filter is no longer supported and will have no effect on the results returned. + */ + acceptsInterstitialPlacements?: boolean; + /** + * Select only directory sites that accept publisher paid placements. This field can be left blank. + */ + acceptsPublisherPaidPlacements?: boolean; + /** + * Select only active directory sites. Leave blank to retrieve both active and inactive directory sites. + */ + active?: boolean; + /** + * Select only directory sites with this Ad Manager network code. + */ + dfpNetworkCode?: string; + /** + * Select only directory sites with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, "directory site*2015" will return objects with names like "directory site June 2015", "directory site April 2015", or simply "directory site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site" will match objects with name "my directory site", "directory site 2015" or simply, "directory site". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + + export class Resource$Dynamictargetingkeys { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.dynamicTargetingKeys.delete + * @desc Deletes an existing dynamic targeting key. + * @alias dfareporting.dynamicTargetingKeys.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase. + * @param {string} params.objectId ID of the object of this dynamic targeting key. This is a required field. + * @param {string} params.objectType Type of the object of this dynamic targeting key. This is a required field. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Dynamictargetingkeys$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Dynamictargetingkeys$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Dynamictargetingkeys$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Dynamictargetingkeys$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Dynamictargetingkeys$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Dynamictargetingkeys$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/dynamicTargetingKeys/{objectId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['profileId', 'objectId', 'name', 'objectType'], + pathParams: ['objectId', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.dynamicTargetingKeys.insert + * @desc Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement. + * @alias dfareporting.dynamicTargetingKeys.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().DynamicTargetingKey} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Dynamictargetingkeys$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Dynamictargetingkeys$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Dynamictargetingkeys$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Dynamictargetingkeys$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Dynamictargetingkeys$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Dynamictargetingkeys$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/dynamicTargetingKeys' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.dynamicTargetingKeys.list + * @desc Retrieves a list of dynamic targeting keys. + * @alias dfareporting.dynamicTargetingKeys.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserId Select only dynamic targeting keys whose object has this advertiser ID. + * @param {string=} params.names Select only dynamic targeting keys exactly matching these names. + * @param {string=} params.objectId Select only dynamic targeting keys with this object ID. + * @param {string=} params.objectType Select only dynamic targeting keys with this object type. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Dynamictargetingkeys$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Dynamictargetingkeys$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Dynamictargetingkeys$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Dynamictargetingkeys$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Dynamictargetingkeys$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Dynamictargetingkeys$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/dynamicTargetingKeys' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Dynamictargetingkeys$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase. + */ + name?: string; + /** + * ID of the object of this dynamic targeting key. This is a required field. + */ + objectId?: string; + /** + * Type of the object of this dynamic targeting key. This is a required field. + */ + objectType?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Dynamictargetingkeys$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DynamicTargetingKey; + } + export interface Params$Resource$Dynamictargetingkeys$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Select only dynamic targeting keys whose object has this advertiser ID. + */ + advertiserId?: string; + /** + * Select only dynamic targeting keys exactly matching these names. + */ + names?: string[]; + /** + * Select only dynamic targeting keys with this object ID. + */ + objectId?: string; + /** + * Select only dynamic targeting keys with this object type. + */ + objectType?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Eventtags { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.eventTags.delete + * @desc Deletes an existing event tag. + * @alias dfareporting.eventTags.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Event tag ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Eventtags$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Eventtags$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Eventtags$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Eventtags$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Eventtags$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Eventtags$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/eventTags/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.eventTags.get + * @desc Gets one event tag by ID. + * @alias dfareporting.eventTags.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Event tag ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Eventtags$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Eventtags$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Eventtags$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Eventtags$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Eventtags$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Eventtags$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/eventTags/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.eventTags.insert + * @desc Inserts a new event tag. + * @alias dfareporting.eventTags.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().EventTag} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Eventtags$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Eventtags$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Eventtags$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Eventtags$Insert + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Eventtags$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Eventtags$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/eventTags' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.eventTags.list + * @desc Retrieves a list of event tags, possibly filtered. + * @alias dfareporting.eventTags.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.adId Select only event tags that belong to this ad. + * @param {string=} params.advertiserId Select only event tags that belong to this advertiser. + * @param {string=} params.campaignId Select only event tags that belong to this campaign. + * @param {boolean=} params.definitionsOnly Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags. + * @param {boolean=} params.enabled Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well. + * @param {string=} params.eventTagTypes Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. + * @param {string=} params.ids Select only event tags with these IDs. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "eventtag*2015" will return objects with names like "eventtag June 2015", "eventtag April 2015", or simply "eventtag 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "eventtag" will match objects with name "my eventtag", "eventtag 2015", or simply "eventtag". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Eventtags$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Eventtags$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Eventtags$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Eventtags$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Eventtags$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Eventtags$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/eventTags' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.eventTags.patch + * @desc Updates an existing event tag. This method supports patch semantics. + * @alias dfareporting.eventTags.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Event tag ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().EventTag} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Eventtags$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Eventtags$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Eventtags$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Eventtags$Patch + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Eventtags$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Eventtags$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/eventTags' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.eventTags.update + * @desc Updates an existing event tag. + * @alias dfareporting.eventTags.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().EventTag} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Eventtags$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Eventtags$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Eventtags$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Eventtags$Update + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Eventtags$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Eventtags$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/eventTags' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Eventtags$Delete extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Event tag ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Eventtags$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Event tag ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Eventtags$Insert extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$EventTag; + } + export interface Params$Resource$Eventtags$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Select only event tags that belong to this ad. + */ + adId?: string; + /** + * Select only event tags that belong to this advertiser. + */ + advertiserId?: string; + /** + * Select only event tags that belong to this campaign. + */ + campaignId?: string; + /** + * Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags. + */ + definitionsOnly?: boolean; + /** + * Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well. + */ + enabled?: boolean; + /** + * Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. + */ + eventTagTypes?: string[]; + /** + * Select only event tags with these IDs. + */ + ids?: string[]; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "eventtag*2015" will return objects with names like "eventtag June 2015", "eventtag April 2015", or simply "eventtag 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "eventtag" will match objects with name "my eventtag", "eventtag 2015", or simply "eventtag". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Eventtags$Patch extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Event tag ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$EventTag; + } + export interface Params$Resource$Eventtags$Update extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$EventTag; + } + + export class Resource$Files { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.files.get + * @desc Retrieves a report file by its report ID and file ID. This method supports media download. + * @alias dfareporting.files.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.fileId The ID of the report file. + * @param {string} params.reportId The ID of the report. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Files$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Files$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Files$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Files$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Files$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Files$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/reports/{reportId}/files/{fileId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['reportId', 'fileId'], + pathParams: ['fileId', 'reportId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.files.list + * @desc Lists files for a user profile. + * @alias dfareporting.files.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken The value of the nextToken from the previous result page. + * @param {string} params.profileId The DFA profile ID. + * @param {string=} params.scope The scope that defines which results are returned. + * @param {string=} params.sortField The field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Files$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Files$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Files$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Files$List + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Files$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Files$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/files' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Files$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The ID of the report file. + */ + fileId?: string; + /** + * The ID of the report. + */ + reportId?: string; + } + export interface Params$Resource$Files$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * The value of the nextToken from the previous result page. + */ + pageToken?: string; + /** + * The DFA profile ID. + */ + profileId?: string; + /** + * The scope that defines which results are returned. + */ + scope?: string; + /** + * The field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + + export class Resource$Floodlightactivities { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.floodlightActivities.delete + * @desc Deletes an existing floodlight activity. + * @alias dfareporting.floodlightActivities.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Floodlight activity ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Floodlightactivities$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Floodlightactivities$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Floodlightactivities$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Floodlightactivities$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightactivities$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightactivities$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/floodlightActivities/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.floodlightActivities.generatetag + * @desc Generates a tag for a floodlight activity. + * @alias dfareporting.floodlightActivities.generatetag + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.floodlightActivityId Floodlight activity ID for which we want to generate a tag. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + generatetag( + params?: Params$Resource$Floodlightactivities$Generatetag, + options?: MethodOptions + ): GaxiosPromise; + generatetag( + params: Params$Resource$Floodlightactivities$Generatetag, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback< + Schema$FloodlightActivitiesGenerateTagResponse + > + ): void; + generatetag( + params: Params$Resource$Floodlightactivities$Generatetag, + callback: BodyResponseCallback< + Schema$FloodlightActivitiesGenerateTagResponse + > + ): void; + generatetag( + callback: BodyResponseCallback< + Schema$FloodlightActivitiesGenerateTagResponse + > + ): void; + generatetag( + paramsOrCallback?: + | Params$Resource$Floodlightactivities$Generatetag + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$FloodlightActivitiesGenerateTagResponse + > + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightactivities$Generatetag; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightactivities$Generatetag; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/floodlightActivities/generatetag' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * dfareporting.floodlightActivities.get + * @desc Gets one floodlight activity by ID. + * @alias dfareporting.floodlightActivities.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Floodlight activity ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Floodlightactivities$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Floodlightactivities$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Floodlightactivities$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Floodlightactivities$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightactivities$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightactivities$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/floodlightActivities/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.floodlightActivities.insert + * @desc Inserts a new floodlight activity. + * @alias dfareporting.floodlightActivities.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().FloodlightActivity} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Floodlightactivities$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Floodlightactivities$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Floodlightactivities$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Floodlightactivities$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightactivities$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightactivities$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/floodlightActivities' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.floodlightActivities.list + * @desc Retrieves a list of floodlight activities, possibly filtered. This method supports paging. + * @alias dfareporting.floodlightActivities.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserId Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. + * @param {string=} params.floodlightActivityGroupIds Select only floodlight activities with the specified floodlight activity group IDs. + * @param {string=} params.floodlightActivityGroupName Select only floodlight activities with the specified floodlight activity group name. + * @param {string=} params.floodlightActivityGroupTagString Select only floodlight activities with the specified floodlight activity group tag string. + * @param {string=} params.floodlightActivityGroupType Select only floodlight activities with the specified floodlight activity group type. + * @param {string=} params.floodlightConfigurationId Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. + * @param {string=} params.ids Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivity*2015" will return objects with names like "floodlightactivity June 2015", "floodlightactivity April 2015", or simply "floodlightactivity 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivity" will match objects with name "my floodlightactivity activity", "floodlightactivity 2015", or simply "floodlightactivity". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {string=} params.tagString Select only floodlight activities with the specified tag string. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Floodlightactivities$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Floodlightactivities$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Floodlightactivities$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Floodlightactivities$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightactivities$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightactivities$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/floodlightActivities' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * dfareporting.floodlightActivities.patch + * @desc Updates an existing floodlight activity. This method supports patch semantics. + * @alias dfareporting.floodlightActivities.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Floodlight activity ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().FloodlightActivity} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Floodlightactivities$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Floodlightactivities$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Floodlightactivities$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Floodlightactivities$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightactivities$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightactivities$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/floodlightActivities' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.floodlightActivities.update + * @desc Updates an existing floodlight activity. + * @alias dfareporting.floodlightActivities.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().FloodlightActivity} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Floodlightactivities$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Floodlightactivities$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Floodlightactivities$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Floodlightactivities$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightactivities$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightactivities$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/floodlightActivities' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Floodlightactivities$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Floodlight activity ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Floodlightactivities$Generatetag + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Floodlight activity ID for which we want to generate a tag. + */ + floodlightActivityId?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Floodlightactivities$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Floodlight activity ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Floodlightactivities$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FloodlightActivity; + } + export interface Params$Resource$Floodlightactivities$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. + */ + advertiserId?: string; + /** + * Select only floodlight activities with the specified floodlight activity group IDs. + */ + floodlightActivityGroupIds?: string[]; + /** + * Select only floodlight activities with the specified floodlight activity group name. + */ + floodlightActivityGroupName?: string; + /** + * Select only floodlight activities with the specified floodlight activity group tag string. + */ + floodlightActivityGroupTagString?: string; + /** + * Select only floodlight activities with the specified floodlight activity group type. + */ + floodlightActivityGroupType?: string; + /** + * Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. + */ + floodlightConfigurationId?: string; + /** + * Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivity*2015" will return objects with names like "floodlightactivity June 2015", "floodlightactivity April 2015", or simply "floodlightactivity 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivity" will match objects with name "my floodlightactivity activity", "floodlightactivity 2015", or simply "floodlightactivity". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + /** + * Select only floodlight activities with the specified tag string. + */ + tagString?: string; + } + export interface Params$Resource$Floodlightactivities$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Floodlight activity ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FloodlightActivity; + } + export interface Params$Resource$Floodlightactivities$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FloodlightActivity; + } + + export class Resource$Floodlightactivitygroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.floodlightActivityGroups.get + * @desc Gets one floodlight activity group by ID. + * @alias dfareporting.floodlightActivityGroups.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Floodlight activity Group ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Floodlightactivitygroups$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Floodlightactivitygroups$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Floodlightactivitygroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Floodlightactivitygroups$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightactivitygroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightactivitygroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/floodlightActivityGroups/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.floodlightActivityGroups.insert + * @desc Inserts a new floodlight activity group. + * @alias dfareporting.floodlightActivityGroups.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().FloodlightActivityGroup} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Floodlightactivitygroups$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Floodlightactivitygroups$Insert, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Floodlightactivitygroups$Insert, + callback: BodyResponseCallback + ): void; + insert( + callback: BodyResponseCallback + ): void; + insert( + paramsOrCallback?: + | Params$Resource$Floodlightactivitygroups$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightactivitygroups$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightactivitygroups$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/floodlightActivityGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.floodlightActivityGroups.list + * @desc Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging. + * @alias dfareporting.floodlightActivityGroups.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserId Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. + * @param {string=} params.floodlightConfigurationId Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result. + * @param {string=} params.ids Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivitygroup*2015" will return objects with names like "floodlightactivitygroup June 2015", "floodlightactivitygroup April 2015", or simply "floodlightactivitygroup 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivitygroup" will match objects with name "my floodlightactivitygroup activity", "floodlightactivitygroup 2015", or simply "floodlightactivitygroup". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {string=} params.type Select only floodlight activity groups with the specified floodlight activity group type. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Floodlightactivitygroups$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Floodlightactivitygroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback< + Schema$FloodlightActivityGroupsListResponse + > + ): void; + list( + params: Params$Resource$Floodlightactivitygroups$List, + callback: BodyResponseCallback< + Schema$FloodlightActivityGroupsListResponse + > + ): void; + list( + callback: BodyResponseCallback< + Schema$FloodlightActivityGroupsListResponse + > + ): void; + list( + paramsOrCallback?: + | Params$Resource$Floodlightactivitygroups$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$FloodlightActivityGroupsListResponse + > + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightactivitygroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightactivitygroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/floodlightActivityGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * dfareporting.floodlightActivityGroups.patch + * @desc Updates an existing floodlight activity group. This method supports patch semantics. + * @alias dfareporting.floodlightActivityGroups.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Floodlight activity Group ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().FloodlightActivityGroup} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Floodlightactivitygroups$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Floodlightactivitygroups$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Floodlightactivitygroups$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Floodlightactivitygroups$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightactivitygroups$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightactivitygroups$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/floodlightActivityGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.floodlightActivityGroups.update + * @desc Updates an existing floodlight activity group. + * @alias dfareporting.floodlightActivityGroups.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().FloodlightActivityGroup} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Floodlightactivitygroups$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Floodlightactivitygroups$Update, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Floodlightactivitygroups$Update, + callback: BodyResponseCallback + ): void; + update( + callback: BodyResponseCallback + ): void; + update( + paramsOrCallback?: + | Params$Resource$Floodlightactivitygroups$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightactivitygroups$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightactivitygroups$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/floodlightActivityGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Floodlightactivitygroups$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Floodlight activity Group ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Floodlightactivitygroups$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FloodlightActivityGroup; + } + export interface Params$Resource$Floodlightactivitygroups$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. + */ + advertiserId?: string; + /** + * Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result. + */ + floodlightConfigurationId?: string; + /** + * Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivitygroup*2015" will return objects with names like "floodlightactivitygroup June 2015", "floodlightactivitygroup April 2015", or simply "floodlightactivitygroup 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivitygroup" will match objects with name "my floodlightactivitygroup activity", "floodlightactivitygroup 2015", or simply "floodlightactivitygroup". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + /** + * Select only floodlight activity groups with the specified floodlight activity group type. + */ + type?: string; + } + export interface Params$Resource$Floodlightactivitygroups$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Floodlight activity Group ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FloodlightActivityGroup; + } + export interface Params$Resource$Floodlightactivitygroups$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FloodlightActivityGroup; + } + + export class Resource$Floodlightconfigurations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.floodlightConfigurations.get + * @desc Gets one floodlight configuration by ID. + * @alias dfareporting.floodlightConfigurations.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Floodlight configuration ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Floodlightconfigurations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Floodlightconfigurations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Floodlightconfigurations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Floodlightconfigurations$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightconfigurations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightconfigurations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/floodlightConfigurations/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.floodlightConfigurations.list + * @desc Retrieves a list of floodlight configurations, possibly filtered. + * @alias dfareporting.floodlightConfigurations.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.ids Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Floodlightconfigurations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Floodlightconfigurations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback< + Schema$FloodlightConfigurationsListResponse + > + ): void; + list( + params: Params$Resource$Floodlightconfigurations$List, + callback: BodyResponseCallback< + Schema$FloodlightConfigurationsListResponse + > + ): void; + list( + callback: BodyResponseCallback< + Schema$FloodlightConfigurationsListResponse + > + ): void; + list( + paramsOrCallback?: + | Params$Resource$Floodlightconfigurations$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$FloodlightConfigurationsListResponse + > + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightconfigurations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightconfigurations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/floodlightConfigurations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * dfareporting.floodlightConfigurations.patch + * @desc Updates an existing floodlight configuration. This method supports patch semantics. + * @alias dfareporting.floodlightConfigurations.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Floodlight configuration ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().FloodlightConfiguration} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Floodlightconfigurations$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Floodlightconfigurations$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Floodlightconfigurations$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Floodlightconfigurations$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightconfigurations$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightconfigurations$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/floodlightConfigurations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.floodlightConfigurations.update + * @desc Updates an existing floodlight configuration. + * @alias dfareporting.floodlightConfigurations.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().FloodlightConfiguration} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Floodlightconfigurations$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Floodlightconfigurations$Update, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Floodlightconfigurations$Update, + callback: BodyResponseCallback + ): void; + update( + callback: BodyResponseCallback + ): void; + update( + paramsOrCallback?: + | Params$Resource$Floodlightconfigurations$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightconfigurations$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightconfigurations$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/floodlightConfigurations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Floodlightconfigurations$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Floodlight configuration ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Floodlightconfigurations$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned. + */ + ids?: string[]; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Floodlightconfigurations$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Floodlight configuration ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FloodlightConfiguration; + } + export interface Params$Resource$Floodlightconfigurations$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FloodlightConfiguration; + } + + export class Resource$Inventoryitems { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.inventoryItems.get + * @desc Gets one inventory item by ID. + * @alias dfareporting.inventoryItems.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Inventory item ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string} params.projectId Project ID for order documents. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Inventoryitems$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Inventoryitems$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Inventoryitems$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Inventoryitems$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventoryitems$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Inventoryitems$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/projects/{projectId}/inventoryItems/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'projectId', 'id'], + pathParams: ['id', 'profileId', 'projectId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.inventoryItems.list + * @desc Retrieves a list of inventory items, possibly filtered. This method supports paging. + * @alias dfareporting.inventoryItems.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.ids Select only inventory items with these IDs. + * @param {boolean=} params.inPlan Select only inventory items that are in plan. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.orderId Select only inventory items that belong to specified orders. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string} params.projectId Project ID for order documents. + * @param {string=} params.siteId Select only inventory items that are associated with these sites. + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {string=} params.type Select only inventory items with this type. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Inventoryitems$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Inventoryitems$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Inventoryitems$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Inventoryitems$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventoryitems$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Inventoryitems$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/projects/{projectId}/inventoryItems' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'projectId'], + pathParams: ['profileId', 'projectId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Inventoryitems$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Inventory item ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Project ID for order documents. + */ + projectId?: string; + } + export interface Params$Resource$Inventoryitems$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Select only inventory items with these IDs. + */ + ids?: string[]; + /** + * Select only inventory items that are in plan. + */ + inPlan?: boolean; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Select only inventory items that belong to specified orders. + */ + orderId?: string[]; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Project ID for order documents. + */ + projectId?: string; + /** + * Select only inventory items that are associated with these sites. + */ + siteId?: string[]; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + /** + * Select only inventory items with this type. + */ + type?: string; + } + + export class Resource$Languages { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.languages.list + * @desc Retrieves a list of languages. + * @alias dfareporting.languages.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Languages$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Languages$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Languages$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Languages$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Languages$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Languages$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/languages' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Languages$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Metros { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.metros.list + * @desc Retrieves a list of metros. + * @alias dfareporting.metros.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Metros$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Metros$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Metros$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Metros$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Metros$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Metros$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/metros' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Metros$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Mobileapps { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.mobileApps.get + * @desc Gets one mobile app by ID. + * @alias dfareporting.mobileApps.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Mobile app ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Mobileapps$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Mobileapps$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Mobileapps$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Mobileapps$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Mobileapps$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Mobileapps$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/mobileApps/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.mobileApps.list + * @desc Retrieves list of available mobile apps. + * @alias dfareporting.mobileApps.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.directories Select only apps from these directories. + * @param {string=} params.ids Select only apps with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "app*2015" will return objects with names like "app Jan 2018", "app Jan 2018", or simply "app 2018". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "app" will match objects with name "my app", "app 2018", or simply "app". + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Mobileapps$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Mobileapps$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Mobileapps$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Mobileapps$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Mobileapps$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Mobileapps$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/mobileApps' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Mobileapps$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Mobile app ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Mobileapps$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Select only apps from these directories. + */ + directories?: string[]; + /** + * Select only apps with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "app*2015" will return objects with names like "app Jan 2018", "app Jan 2018", or simply "app 2018". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "app" will match objects with name "my app", "app 2018", or simply "app". + */ + searchString?: string; + } + + export class Resource$Mobilecarriers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.mobileCarriers.get + * @desc Gets one mobile carrier by ID. + * @alias dfareporting.mobileCarriers.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Mobile carrier ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Mobilecarriers$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Mobilecarriers$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Mobilecarriers$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Mobilecarriers$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Mobilecarriers$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Mobilecarriers$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/mobileCarriers/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.mobileCarriers.list + * @desc Retrieves a list of mobile carriers. + * @alias dfareporting.mobileCarriers.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Mobilecarriers$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Mobilecarriers$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Mobilecarriers$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Mobilecarriers$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Mobilecarriers$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Mobilecarriers$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/mobileCarriers' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Mobilecarriers$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Mobile carrier ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Mobilecarriers$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Operatingsystems { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.operatingSystems.get + * @desc Gets one operating system by DART ID. + * @alias dfareporting.operatingSystems.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.dartId Operating system DART ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Operatingsystems$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Operatingsystems$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Operatingsystems$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Operatingsystems$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Operatingsystems$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operatingsystems$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/operatingSystems/{dartId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'dartId'], + pathParams: ['dartId', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.operatingSystems.list + * @desc Retrieves a list of operating systems. + * @alias dfareporting.operatingSystems.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Operatingsystems$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Operatingsystems$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Operatingsystems$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Operatingsystems$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Operatingsystems$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operatingsystems$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/operatingSystems' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Operatingsystems$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Operating system DART ID. + */ + dartId?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Operatingsystems$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Operatingsystemversions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.operatingSystemVersions.get + * @desc Gets one operating system version by ID. + * @alias dfareporting.operatingSystemVersions.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Operating system version ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Operatingsystemversions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Operatingsystemversions$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Operatingsystemversions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Operatingsystemversions$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Operatingsystemversions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operatingsystemversions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/operatingSystemVersions/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.operatingSystemVersions.list + * @desc Retrieves a list of operating system versions. + * @alias dfareporting.operatingSystemVersions.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Operatingsystemversions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Operatingsystemversions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Operatingsystemversions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Operatingsystemversions$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$OperatingSystemVersionsListResponse + > + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Operatingsystemversions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operatingsystemversions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/operatingSystemVersions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Operatingsystemversions$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Operating system version ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Operatingsystemversions$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Orderdocuments { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.orderDocuments.get + * @desc Gets one order document by ID. + * @alias dfareporting.orderDocuments.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Order document ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string} params.projectId Project ID for order documents. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Orderdocuments$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Orderdocuments$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Orderdocuments$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Orderdocuments$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Orderdocuments$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Orderdocuments$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'projectId', 'id'], + pathParams: ['id', 'profileId', 'projectId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.orderDocuments.list + * @desc Retrieves a list of order documents, possibly filtered. This method supports paging. + * @alias dfareporting.orderDocuments.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.approved Select only order documents that have been approved by at least one user. + * @param {string=} params.ids Select only order documents with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.orderId Select only order documents for specified orders. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string} params.projectId Project ID for order documents. + * @param {string=} params.searchString Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, "orderdocument*2015" will return order documents with names like "orderdocument June 2015", "orderdocument April 2015", or simply "orderdocument 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "orderdocument" will match order documents with name "my orderdocument", "orderdocument 2015", or simply "orderdocument". + * @param {string=} params.siteId Select only order documents that are associated with these sites. + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Orderdocuments$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Orderdocuments$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Orderdocuments$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Orderdocuments$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Orderdocuments$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Orderdocuments$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/projects/{projectId}/orderDocuments' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'projectId'], + pathParams: ['profileId', 'projectId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Orderdocuments$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Order document ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Project ID for order documents. + */ + projectId?: string; + } + export interface Params$Resource$Orderdocuments$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Select only order documents that have been approved by at least one user. + */ + approved?: boolean; + /** + * Select only order documents with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Select only order documents for specified orders. + */ + orderId?: string[]; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Project ID for order documents. + */ + projectId?: string; + /** + * Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, "orderdocument*2015" will return order documents with names like "orderdocument June 2015", "orderdocument April 2015", or simply "orderdocument 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "orderdocument" will match order documents with name "my orderdocument", "orderdocument 2015", or simply "orderdocument". + */ + searchString?: string; + /** + * Select only order documents that are associated with these sites. + */ + siteId?: string[]; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + + export class Resource$Orders { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.orders.get + * @desc Gets one order by ID. + * @alias dfareporting.orders.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Order ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string} params.projectId Project ID for orders. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Orders$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Orders$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Orders$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Orders$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Orders$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Orders$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/projects/{projectId}/orders/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'projectId', 'id'], + pathParams: ['id', 'profileId', 'projectId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.orders.list + * @desc Retrieves a list of orders, possibly filtered. This method supports paging. + * @alias dfareporting.orders.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.ids Select only orders with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string} params.projectId Project ID for orders. + * @param {string=} params.searchString Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, "order*2015" will return orders with names like "order June 2015", "order April 2015", or simply "order 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "order" will match orders with name "my order", "order 2015", or simply "order". + * @param {string=} params.siteId Select only orders that are associated with these site IDs. + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Orders$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Orders$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Orders$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Orders$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Orders$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Orders$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/projects/{projectId}/orders' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'projectId'], + pathParams: ['profileId', 'projectId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Orders$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Order ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Project ID for orders. + */ + projectId?: string; + } + export interface Params$Resource$Orders$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Select only orders with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Project ID for orders. + */ + projectId?: string; + /** + * Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, "order*2015" will return orders with names like "order June 2015", "order April 2015", or simply "order 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "order" will match orders with name "my order", "order 2015", or simply "order". + */ + searchString?: string; + /** + * Select only orders that are associated with these site IDs. + */ + siteId?: string[]; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + + export class Resource$Placementgroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.placementGroups.get + * @desc Gets one placement group by ID. + * @alias dfareporting.placementGroups.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Placement group ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Placementgroups$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Placementgroups$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Placementgroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Placementgroups$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Placementgroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placementgroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/placementGroups/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.placementGroups.insert + * @desc Inserts a new placement group. + * @alias dfareporting.placementGroups.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().PlacementGroup} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Placementgroups$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Placementgroups$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Placementgroups$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Placementgroups$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Placementgroups$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placementgroups$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/placementGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.placementGroups.list + * @desc Retrieves a list of placement groups, possibly filtered. This method supports paging. + * @alias dfareporting.placementGroups.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserIds Select only placement groups that belong to these advertisers. + * @param {boolean=} params.archived Select only archived placements. Don't set this field to select both archived and non-archived placements. + * @param {string=} params.campaignIds Select only placement groups that belong to these campaigns. + * @param {string=} params.contentCategoryIds Select only placement groups that are associated with these content categories. + * @param {string=} params.directorySiteIds Select only placement groups that are associated with these directory sites. + * @param {string=} params.ids Select only placement groups with these IDs. + * @param {string=} params.maxEndDate Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.maxStartDate Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". + * @param {string=} params.minEndDate Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd". + * @param {string=} params.minStartDate Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd". + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string=} params.placementGroupType Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. + * @param {string=} params.placementStrategyIds Select only placement groups that are associated with these placement strategies. + * @param {string=} params.pricingTypes Select only placement groups with these pricing types. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placement groups with names like "placement group June 2015", "placement group May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementgroup" will match placement groups with name "my placementgroup", "placementgroup 2015", or simply "placementgroup". + * @param {string=} params.siteIds Select only placement groups that are associated with these sites. + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Placementgroups$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Placementgroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Placementgroups$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Placementgroups$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Placementgroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placementgroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/placementGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.placementGroups.patch + * @desc Updates an existing placement group. This method supports patch semantics. + * @alias dfareporting.placementGroups.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Placement group ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().PlacementGroup} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Placementgroups$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Placementgroups$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Placementgroups$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Placementgroups$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Placementgroups$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placementgroups$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/placementGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.placementGroups.update + * @desc Updates an existing placement group. + * @alias dfareporting.placementGroups.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().PlacementGroup} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Placementgroups$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Placementgroups$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Placementgroups$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Placementgroups$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Placementgroups$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placementgroups$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/placementGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Placementgroups$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Placement group ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Placementgroups$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PlacementGroup; + } + export interface Params$Resource$Placementgroups$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Select only placement groups that belong to these advertisers. + */ + advertiserIds?: string[]; + /** + * Select only archived placements. Don't set this field to select both archived and non-archived placements. + */ + archived?: boolean; + /** + * Select only placement groups that belong to these campaigns. + */ + campaignIds?: string[]; + /** + * Select only placement groups that are associated with these content categories. + */ + contentCategoryIds?: string[]; + /** + * Select only placement groups that are associated with these directory sites. + */ + directorySiteIds?: string[]; + /** + * Select only placement groups with these IDs. + */ + ids?: string[]; + /** + * Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". + */ + maxEndDate?: string; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". + */ + maxStartDate?: string; + /** + * Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd". + */ + minEndDate?: string; + /** + * Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd". + */ + minStartDate?: string; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. + */ + placementGroupType?: string; + /** + * Select only placement groups that are associated with these placement strategies. + */ + placementStrategyIds?: string[]; + /** + * Select only placement groups with these pricing types. + */ + pricingTypes?: string[]; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placement groups with names like "placement group June 2015", "placement group May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementgroup" will match placement groups with name "my placementgroup", "placementgroup 2015", or simply "placementgroup". + */ + searchString?: string; + /** + * Select only placement groups that are associated with these sites. + */ + siteIds?: string[]; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Placementgroups$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Placement group ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PlacementGroup; + } + export interface Params$Resource$Placementgroups$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PlacementGroup; + } + + export class Resource$Placements { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.placements.generatetags + * @desc Generates tags for a placement. + * @alias dfareporting.placements.generatetags + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.campaignId Generate placements belonging to this campaign. This is a required field. + * @param {string=} params.placementIds Generate tags for these placements. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.tagFormats Tag formats to generate for these placements. Note: PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + generatetags( + params?: Params$Resource$Placements$Generatetags, + options?: MethodOptions + ): GaxiosPromise; + generatetags( + params: Params$Resource$Placements$Generatetags, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generatetags( + params: Params$Resource$Placements$Generatetags, + callback: BodyResponseCallback + ): void; + generatetags( + callback: BodyResponseCallback + ): void; + generatetags( + paramsOrCallback?: + | Params$Resource$Placements$Generatetags + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Placements$Generatetags; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placements$Generatetags; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/placements/generatetags' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * dfareporting.placements.get + * @desc Gets one placement by ID. + * @alias dfareporting.placements.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Placement ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Placements$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Placements$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Placements$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Placements$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Placements$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placements$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/placements/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.placements.insert + * @desc Inserts a new placement. + * @alias dfareporting.placements.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Placement} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Placements$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Placements$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Placements$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Placements$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Placements$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placements$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/placements' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.placements.list + * @desc Retrieves a list of placements, possibly filtered. This method supports paging. + * @alias dfareporting.placements.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserIds Select only placements that belong to these advertisers. + * @param {boolean=} params.archived Select only archived placements. Don't set this field to select both archived and non-archived placements. + * @param {string=} params.campaignIds Select only placements that belong to these campaigns. + * @param {string=} params.compatibilities Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. + * @param {string=} params.contentCategoryIds Select only placements that are associated with these content categories. + * @param {string=} params.directorySiteIds Select only placements that are associated with these directory sites. + * @param {string=} params.groupIds Select only placements that belong to these placement groups. + * @param {string=} params.ids Select only placements with these IDs. + * @param {string=} params.maxEndDate Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.maxStartDate Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". + * @param {string=} params.minEndDate Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd". + * @param {string=} params.minStartDate Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd". + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string=} params.paymentSource Select only placements with this payment source. + * @param {string=} params.placementStrategyIds Select only placements that are associated with these placement strategies. + * @param {string=} params.pricingTypes Select only placements with these pricing types. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placements with names like "placement June 2015", "placement May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placement" will match placements with name "my placement", "placement 2015", or simply "placement". + * @param {string=} params.siteIds Select only placements that are associated with these sites. + * @param {string=} params.sizeIds Select only placements that are associated with these sizes. + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Placements$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Placements$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Placements$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Placements$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Placements$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placements$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/placements' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.placements.patch + * @desc Updates an existing placement. This method supports patch semantics. + * @alias dfareporting.placements.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Placement ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Placement} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Placements$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Placements$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Placements$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Placements$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Placements$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placements$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/placements' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.placements.update + * @desc Updates an existing placement. + * @alias dfareporting.placements.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Placement} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Placements$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Placements$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Placements$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Placements$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Placements$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placements$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/placements' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Placements$Generatetags + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Generate placements belonging to this campaign. This is a required field. + */ + campaignId?: string; + /** + * Generate tags for these placements. + */ + placementIds?: string[]; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Tag formats to generate for these placements. Note: PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements. + */ + tagFormats?: string[]; + } + export interface Params$Resource$Placements$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Placement ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Placements$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Placement; + } + export interface Params$Resource$Placements$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Select only placements that belong to these advertisers. + */ + advertiserIds?: string[]; + /** + * Select only archived placements. Don't set this field to select both archived and non-archived placements. + */ + archived?: boolean; + /** + * Select only placements that belong to these campaigns. + */ + campaignIds?: string[]; + /** + * Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. + */ + compatibilities?: string[]; + /** + * Select only placements that are associated with these content categories. + */ + contentCategoryIds?: string[]; + /** + * Select only placements that are associated with these directory sites. + */ + directorySiteIds?: string[]; + /** + * Select only placements that belong to these placement groups. + */ + groupIds?: string[]; + /** + * Select only placements with these IDs. + */ + ids?: string[]; + /** + * Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". + */ + maxEndDate?: string; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". + */ + maxStartDate?: string; + /** + * Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd". + */ + minEndDate?: string; + /** + * Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd". + */ + minStartDate?: string; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * Select only placements with this payment source. + */ + paymentSource?: string; + /** + * Select only placements that are associated with these placement strategies. + */ + placementStrategyIds?: string[]; + /** + * Select only placements with these pricing types. + */ + pricingTypes?: string[]; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placements with names like "placement June 2015", "placement May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placement" will match placements with name "my placement", "placement 2015", or simply "placement". + */ + searchString?: string; + /** + * Select only placements that are associated with these sites. + */ + siteIds?: string[]; + /** + * Select only placements that are associated with these sizes. + */ + sizeIds?: string[]; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Placements$Patch extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Placement ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Placement; + } + export interface Params$Resource$Placements$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Placement; + } + + export class Resource$Placementstrategies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.placementStrategies.delete + * @desc Deletes an existing placement strategy. + * @alias dfareporting.placementStrategies.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Placement strategy ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Placementstrategies$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Placementstrategies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Placementstrategies$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Placementstrategies$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Placementstrategies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placementstrategies$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/placementStrategies/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.placementStrategies.get + * @desc Gets one placement strategy by ID. + * @alias dfareporting.placementStrategies.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Placement strategy ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Placementstrategies$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Placementstrategies$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Placementstrategies$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Placementstrategies$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Placementstrategies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placementstrategies$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/placementStrategies/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.placementStrategies.insert + * @desc Inserts a new placement strategy. + * @alias dfareporting.placementStrategies.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().PlacementStrategy} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Placementstrategies$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Placementstrategies$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Placementstrategies$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Placementstrategies$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Placementstrategies$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placementstrategies$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/placementStrategies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.placementStrategies.list + * @desc Retrieves a list of placement strategies, possibly filtered. This method supports paging. + * @alias dfareporting.placementStrategies.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.ids Select only placement strategies with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "placementstrategy*2015" will return objects with names like "placementstrategy June 2015", "placementstrategy April 2015", or simply "placementstrategy 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementstrategy" will match objects with name "my placementstrategy", "placementstrategy 2015", or simply "placementstrategy". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Placementstrategies$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Placementstrategies$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Placementstrategies$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Placementstrategies$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Placementstrategies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placementstrategies$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/placementStrategies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * dfareporting.placementStrategies.patch + * @desc Updates an existing placement strategy. This method supports patch semantics. + * @alias dfareporting.placementStrategies.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Placement strategy ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().PlacementStrategy} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Placementstrategies$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Placementstrategies$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Placementstrategies$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Placementstrategies$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Placementstrategies$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placementstrategies$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/placementStrategies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.placementStrategies.update + * @desc Updates an existing placement strategy. + * @alias dfareporting.placementStrategies.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().PlacementStrategy} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Placementstrategies$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Placementstrategies$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Placementstrategies$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Placementstrategies$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Placementstrategies$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placementstrategies$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/placementStrategies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Placementstrategies$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Placement strategy ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Placementstrategies$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Placement strategy ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Placementstrategies$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PlacementStrategy; + } + export interface Params$Resource$Placementstrategies$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Select only placement strategies with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "placementstrategy*2015" will return objects with names like "placementstrategy June 2015", "placementstrategy April 2015", or simply "placementstrategy 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementstrategy" will match objects with name "my placementstrategy", "placementstrategy 2015", or simply "placementstrategy". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Placementstrategies$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Placement strategy ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PlacementStrategy; + } + export interface Params$Resource$Placementstrategies$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PlacementStrategy; + } + + export class Resource$Platformtypes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.platformTypes.get + * @desc Gets one platform type by ID. + * @alias dfareporting.platformTypes.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Platform type ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Platformtypes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Platformtypes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Platformtypes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Platformtypes$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Platformtypes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platformtypes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/platformTypes/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.platformTypes.list + * @desc Retrieves a list of platform types. + * @alias dfareporting.platformTypes.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Platformtypes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Platformtypes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Platformtypes$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Platformtypes$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Platformtypes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platformtypes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/platformTypes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Platformtypes$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Platform type ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Platformtypes$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Postalcodes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.postalCodes.get + * @desc Gets one postal code by ID. + * @alias dfareporting.postalCodes.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.code Postal code ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Postalcodes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Postalcodes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Postalcodes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Postalcodes$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Postalcodes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Postalcodes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/postalCodes/{code}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'code'], + pathParams: ['code', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.postalCodes.list + * @desc Retrieves a list of postal codes. + * @alias dfareporting.postalCodes.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Postalcodes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Postalcodes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Postalcodes$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Postalcodes$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Postalcodes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Postalcodes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/postalCodes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Postalcodes$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Postal code ID. + */ + code?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Postalcodes$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Projects { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.projects.get + * @desc Gets one project by ID. + * @alias dfareporting.projects.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Project ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Projects$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Projects$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/projects/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.projects.list + * @desc Retrieves a list of projects, possibly filtered. This method supports paging. + * @alias dfareporting.projects.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserIds Select only projects with these advertiser IDs. + * @param {string=} params.ids Select only projects with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, "project*2015" will return projects with names like "project June 2015", "project April 2015", or simply "project 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "project" will match projects with name "my project", "project 2015", or simply "project". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Projects$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/projects' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Projects$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Select only projects with these advertiser IDs. + */ + advertiserIds?: string[]; + /** + * Select only projects with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, "project*2015" will return projects with names like "project June 2015", "project April 2015", or simply "project 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "project" will match projects with name "my project", "project 2015", or simply "project". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + + export class Resource$Regions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.regions.list + * @desc Retrieves a list of regions. + * @alias dfareporting.regions.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Regions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regions$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regions$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Regions$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Regions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/regions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regions$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Remarketinglists { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.remarketingLists.get + * @desc Gets one remarketing list by ID. + * @alias dfareporting.remarketingLists.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Remarketing list ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Remarketinglists$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Remarketinglists$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Remarketinglists$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Remarketinglists$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Remarketinglists$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Remarketinglists$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/remarketingLists/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.remarketingLists.insert + * @desc Inserts a new remarketing list. + * @alias dfareporting.remarketingLists.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().RemarketingList} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Remarketinglists$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Remarketinglists$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Remarketinglists$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Remarketinglists$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Remarketinglists$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Remarketinglists$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/remarketingLists' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.remarketingLists.list + * @desc Retrieves a list of remarketing lists, possibly filtered. This method supports paging. + * @alias dfareporting.remarketingLists.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.active Select only active or only inactive remarketing lists. + * @param {string} params.advertiserId Select only remarketing lists owned by this advertiser. + * @param {string=} params.floodlightActivityId Select only remarketing lists that have this floodlight activity ID. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.name Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list". + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Remarketinglists$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Remarketinglists$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Remarketinglists$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Remarketinglists$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Remarketinglists$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Remarketinglists$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/remarketingLists' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'advertiserId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * dfareporting.remarketingLists.patch + * @desc Updates an existing remarketing list. This method supports patch semantics. + * @alias dfareporting.remarketingLists.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Remarketing list ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().RemarketingList} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Remarketinglists$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Remarketinglists$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Remarketinglists$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Remarketinglists$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Remarketinglists$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Remarketinglists$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/remarketingLists' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.remarketingLists.update + * @desc Updates an existing remarketing list. + * @alias dfareporting.remarketingLists.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().RemarketingList} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Remarketinglists$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Remarketinglists$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Remarketinglists$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Remarketinglists$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Remarketinglists$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Remarketinglists$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/remarketingLists' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Remarketinglists$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Remarketing list ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Remarketinglists$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RemarketingList; + } + export interface Params$Resource$Remarketinglists$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Select only active or only inactive remarketing lists. + */ + active?: boolean; + /** + * Select only remarketing lists owned by this advertiser. + */ + advertiserId?: string; + /** + * Select only remarketing lists that have this floodlight activity ID. + */ + floodlightActivityId?: string; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list". + */ + name?: string; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Remarketinglists$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Remarketing list ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RemarketingList; + } + export interface Params$Resource$Remarketinglists$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RemarketingList; + } + + export class Resource$Remarketinglistshares { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.remarketingListShares.get + * @desc Gets one remarketing list share by remarketing list ID. + * @alias dfareporting.remarketingListShares.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {string} params.remarketingListId Remarketing list ID. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Remarketinglistshares$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Remarketinglistshares$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Remarketinglistshares$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Remarketinglistshares$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Remarketinglistshares$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Remarketinglistshares$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/remarketingListShares/{remarketingListId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'remarketingListId'], + pathParams: ['profileId', 'remarketingListId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.remarketingListShares.patch + * @desc Updates an existing remarketing list share. This method supports patch semantics. + * @alias dfareporting.remarketingListShares.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {string} params.remarketingListId Remarketing list ID. + * @param {().RemarketingListShare} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Remarketinglistshares$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Remarketinglistshares$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Remarketinglistshares$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Remarketinglistshares$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Remarketinglistshares$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Remarketinglistshares$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/remarketingListShares' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['profileId', 'remarketingListId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.remarketingListShares.update + * @desc Updates an existing remarketing list share. + * @alias dfareporting.remarketingListShares.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().RemarketingListShare} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Remarketinglistshares$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Remarketinglistshares$Update, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Remarketinglistshares$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Remarketinglistshares$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Remarketinglistshares$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Remarketinglistshares$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/remarketingListShares' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Remarketinglistshares$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Remarketing list ID. + */ + remarketingListId?: string; + } + export interface Params$Resource$Remarketinglistshares$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Remarketing list ID. + */ + remarketingListId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RemarketingListShare; + } + export interface Params$Resource$Remarketinglistshares$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RemarketingListShare; + } + + export class Resource$Reports { + context: APIRequestContext; + compatibleFields: Resource$Reports$Compatiblefields; + files: Resource$Reports$Files; + constructor(context: APIRequestContext) { + this.context = context; + this.compatibleFields = new Resource$Reports$Compatiblefields( + this.context + ); + this.files = new Resource$Reports$Files(this.context); + } + + /** + * dfareporting.reports.delete + * @desc Deletes a report by its ID. + * @alias dfareporting.reports.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId The DFA user profile ID. + * @param {string} params.reportId The ID of the report. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Reports$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Reports$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Reports$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Reports$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Reports$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reports$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/reports/{reportId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['profileId', 'reportId'], + pathParams: ['profileId', 'reportId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.reports.get + * @desc Retrieves a report by its ID. + * @alias dfareporting.reports.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId The DFA user profile ID. + * @param {string} params.reportId The ID of the report. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Reports$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Reports$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Reports$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Reports$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Reports$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reports$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/reports/{reportId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'reportId'], + pathParams: ['profileId', 'reportId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.reports.insert + * @desc Creates a report. + * @alias dfareporting.reports.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId The DFA user profile ID. + * @param {().Report} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Reports$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Reports$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Reports$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Reports$Insert + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Reports$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reports$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/reports' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.reports.list + * @desc Retrieves list of reports. + * @alias dfareporting.reports.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken The value of the nextToken from the previous result page. + * @param {string} params.profileId The DFA user profile ID. + * @param {string=} params.scope The scope that defines which results are returned. + * @param {string=} params.sortField The field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Reports$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Reports$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Reports$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Reports$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Reports$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reports$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/reports' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.reports.patch + * @desc Updates a report. This method supports patch semantics. + * @alias dfareporting.reports.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId The DFA user profile ID. + * @param {string} params.reportId The ID of the report. + * @param {().Report} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Reports$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Reports$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Reports$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Reports$Patch + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Reports$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reports$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/reports/{reportId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['profileId', 'reportId'], + pathParams: ['profileId', 'reportId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.reports.run + * @desc Runs a report. + * @alias dfareporting.reports.run + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId The DFA profile ID. + * @param {string} params.reportId The ID of the report. + * @param {boolean=} params.synchronous If set and true, tries to run the report synchronously. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + run( + params?: Params$Resource$Reports$Run, + options?: MethodOptions + ): GaxiosPromise; + run( + params: Params$Resource$Reports$Run, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + run( + params: Params$Resource$Reports$Run, + callback: BodyResponseCallback + ): void; + run(callback: BodyResponseCallback): void; + run( + paramsOrCallback?: + | Params$Resource$Reports$Run + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Reports$Run; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reports$Run; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/reports/{reportId}/run' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['profileId', 'reportId'], + pathParams: ['profileId', 'reportId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.reports.update + * @desc Updates a report. + * @alias dfareporting.reports.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId The DFA user profile ID. + * @param {string} params.reportId The ID of the report. + * @param {().Report} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Reports$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Reports$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Reports$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Reports$Update + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Reports$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reports$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/reports/{reportId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['profileId', 'reportId'], + pathParams: ['profileId', 'reportId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Reports$Delete extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The DFA user profile ID. + */ + profileId?: string; + /** + * The ID of the report. + */ + reportId?: string; + } + export interface Params$Resource$Reports$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The DFA user profile ID. + */ + profileId?: string; + /** + * The ID of the report. + */ + reportId?: string; + } + export interface Params$Resource$Reports$Insert extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The DFA user profile ID. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Report; + } + export interface Params$Resource$Reports$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * The value of the nextToken from the previous result page. + */ + pageToken?: string; + /** + * The DFA user profile ID. + */ + profileId?: string; + /** + * The scope that defines which results are returned. + */ + scope?: string; + /** + * The field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Reports$Patch extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The DFA user profile ID. + */ + profileId?: string; + /** + * The ID of the report. + */ + reportId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Report; + } + export interface Params$Resource$Reports$Run extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The DFA profile ID. + */ + profileId?: string; + /** + * The ID of the report. + */ + reportId?: string; + /** + * If set and true, tries to run the report synchronously. + */ + synchronous?: boolean; + } + export interface Params$Resource$Reports$Update extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The DFA user profile ID. + */ + profileId?: string; + /** + * The ID of the report. + */ + reportId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Report; + } + + export class Resource$Reports$Compatiblefields { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.reports.compatibleFields.query + * @desc Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions. + * @alias dfareporting.reports.compatibleFields.query + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId The DFA user profile ID. + * @param {().Report} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + query( + params?: Params$Resource$Reports$Compatiblefields$Query, + options?: MethodOptions + ): GaxiosPromise; + query( + params: Params$Resource$Reports$Compatiblefields$Query, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + query( + params: Params$Resource$Reports$Compatiblefields$Query, + callback: BodyResponseCallback + ): void; + query(callback: BodyResponseCallback): void; + query( + paramsOrCallback?: + | Params$Resource$Reports$Compatiblefields$Query + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Reports$Compatiblefields$Query; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reports$Compatiblefields$Query; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/reports/compatiblefields/query' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Reports$Compatiblefields$Query + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The DFA user profile ID. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Report; + } + + export class Resource$Reports$Files { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.reports.files.get + * @desc Retrieves a report file. This method supports media download. + * @alias dfareporting.reports.files.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.fileId The ID of the report file. + * @param {string} params.profileId The DFA profile ID. + * @param {string} params.reportId The ID of the report. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Reports$Files$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Reports$Files$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Reports$Files$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Reports$Files$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Reports$Files$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reports$Files$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/reports/{reportId}/files/{fileId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'reportId', 'fileId'], + pathParams: ['fileId', 'profileId', 'reportId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.reports.files.list + * @desc Lists files for a report. + * @alias dfareporting.reports.files.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken The value of the nextToken from the previous result page. + * @param {string} params.profileId The DFA profile ID. + * @param {string} params.reportId The ID of the parent report. + * @param {string=} params.sortField The field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Reports$Files$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Reports$Files$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Reports$Files$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Reports$Files$List + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Reports$Files$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reports$Files$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/reports/{reportId}/files' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'reportId'], + pathParams: ['profileId', 'reportId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Reports$Files$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The ID of the report file. + */ + fileId?: string; + /** + * The DFA profile ID. + */ + profileId?: string; + /** + * The ID of the report. + */ + reportId?: string; + } + export interface Params$Resource$Reports$Files$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * The value of the nextToken from the previous result page. + */ + pageToken?: string; + /** + * The DFA profile ID. + */ + profileId?: string; + /** + * The ID of the parent report. + */ + reportId?: string; + /** + * The field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + + export class Resource$Sites { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.sites.get + * @desc Gets one site by ID. + * @alias dfareporting.sites.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Site ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Sites$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Sites$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Sites$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Sites$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Sites$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sites$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/sites/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.sites.insert + * @desc Inserts a new site. + * @alias dfareporting.sites.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Site} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Sites$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Sites$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Sites$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Sites$Insert + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Sites$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sites$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/sites' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.sites.list + * @desc Retrieves a list of sites, possibly filtered. This method supports paging. + * @alias dfareporting.sites.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.acceptsInStreamVideoPlacements This search filter is no longer supported and will have no effect on the results returned. + * @param {boolean=} params.acceptsInterstitialPlacements This search filter is no longer supported and will have no effect on the results returned. + * @param {boolean=} params.acceptsPublisherPaidPlacements Select only sites that accept publisher paid placements. + * @param {boolean=} params.adWordsSite Select only AdWords sites. + * @param {boolean=} params.approved Select only approved sites. + * @param {string=} params.campaignIds Select only sites with these campaign IDs. + * @param {string=} params.directorySiteIds Select only sites with these directory site IDs. + * @param {string=} params.ids Select only sites with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, "site*2015" will return objects with names like "site June 2015", "site April 2015", or simply "site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "site" will match objects with name "my site", "site 2015", or simply "site". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {string=} params.subaccountId Select only sites with this subaccount ID. + * @param {boolean=} params.unmappedSite Select only sites that have not been mapped to a directory site. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Sites$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Sites$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Sites$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Sites$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Sites$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sites$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/sites' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.sites.patch + * @desc Updates an existing site. This method supports patch semantics. + * @alias dfareporting.sites.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Site ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Site} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Sites$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Sites$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Sites$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Sites$Patch + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Sites$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sites$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/sites' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.sites.update + * @desc Updates an existing site. + * @alias dfareporting.sites.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Site} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Sites$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Sites$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Sites$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Sites$Update + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Sites$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sites$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/sites' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Sites$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Site ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Sites$Insert extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Site; + } + export interface Params$Resource$Sites$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * This search filter is no longer supported and will have no effect on the results returned. + */ + acceptsInStreamVideoPlacements?: boolean; + /** + * This search filter is no longer supported and will have no effect on the results returned. + */ + acceptsInterstitialPlacements?: boolean; + /** + * Select only sites that accept publisher paid placements. + */ + acceptsPublisherPaidPlacements?: boolean; + /** + * Select only AdWords sites. + */ + adWordsSite?: boolean; + /** + * Select only approved sites. + */ + approved?: boolean; + /** + * Select only sites with these campaign IDs. + */ + campaignIds?: string[]; + /** + * Select only sites with these directory site IDs. + */ + directorySiteIds?: string[]; + /** + * Select only sites with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, "site*2015" will return objects with names like "site June 2015", "site April 2015", or simply "site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "site" will match objects with name "my site", "site 2015", or simply "site". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + /** + * Select only sites with this subaccount ID. + */ + subaccountId?: string; + /** + * Select only sites that have not been mapped to a directory site. + */ + unmappedSite?: boolean; + } + export interface Params$Resource$Sites$Patch extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Site ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Site; + } + export interface Params$Resource$Sites$Update extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Site; + } + + export class Resource$Sizes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.sizes.get + * @desc Gets one size by ID. + * @alias dfareporting.sizes.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Size ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Sizes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Sizes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Sizes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Sizes$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Sizes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sizes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/sizes/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.sizes.insert + * @desc Inserts a new size. + * @alias dfareporting.sizes.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Size} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Sizes$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Sizes$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Sizes$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Sizes$Insert + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Sizes$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sizes$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/sizes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.sizes.list + * @desc Retrieves a list of sizes, possibly filtered. Retrieved sizes are globally unique and may include values not currently in use by your account. Due to this, the list of sizes returned by this method may differ from the list seen in the Trafficking UI. + * @alias dfareporting.sizes.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.height Select only sizes with this height. + * @param {boolean=} params.iabStandard Select only IAB standard sizes. + * @param {string=} params.ids Select only sizes with these IDs. + * @param {string} params.profileId User profile ID associated with this request. + * @param {integer=} params.width Select only sizes with this width. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Sizes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Sizes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Sizes$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Sizes$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Sizes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sizes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/sizes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Sizes$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Size ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Sizes$Insert extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Size; + } + export interface Params$Resource$Sizes$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Select only sizes with this height. + */ + height?: number; + /** + * Select only IAB standard sizes. + */ + iabStandard?: boolean; + /** + * Select only sizes with these IDs. + */ + ids?: string[]; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Select only sizes with this width. + */ + width?: number; + } + + export class Resource$Subaccounts { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.subaccounts.get + * @desc Gets one subaccount by ID. + * @alias dfareporting.subaccounts.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Subaccount ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Subaccounts$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Subaccounts$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Subaccounts$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Subaccounts$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Subaccounts$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Subaccounts$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/subaccounts/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.subaccounts.insert + * @desc Inserts a new subaccount. + * @alias dfareporting.subaccounts.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Subaccount} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Subaccounts$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Subaccounts$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Subaccounts$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Subaccounts$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Subaccounts$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Subaccounts$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/subaccounts' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.subaccounts.list + * @desc Gets a list of subaccounts, possibly filtered. This method supports paging. + * @alias dfareporting.subaccounts.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.ids Select only subaccounts with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "subaccount*2015" will return objects with names like "subaccount June 2015", "subaccount April 2015", or simply "subaccount 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "subaccount" will match objects with name "my subaccount", "subaccount 2015", or simply "subaccount". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Subaccounts$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Subaccounts$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Subaccounts$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Subaccounts$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Subaccounts$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Subaccounts$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/subaccounts' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.subaccounts.patch + * @desc Updates an existing subaccount. This method supports patch semantics. + * @alias dfareporting.subaccounts.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Subaccount ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Subaccount} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Subaccounts$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Subaccounts$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Subaccounts$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Subaccounts$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Subaccounts$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Subaccounts$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/subaccounts' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.subaccounts.update + * @desc Updates an existing subaccount. + * @alias dfareporting.subaccounts.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Subaccount} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Subaccounts$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Subaccounts$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Subaccounts$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Subaccounts$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Subaccounts$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Subaccounts$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/subaccounts' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Subaccounts$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Subaccount ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Subaccounts$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Subaccount; + } + export interface Params$Resource$Subaccounts$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Select only subaccounts with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "subaccount*2015" will return objects with names like "subaccount June 2015", "subaccount April 2015", or simply "subaccount 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "subaccount" will match objects with name "my subaccount", "subaccount 2015", or simply "subaccount". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Subaccounts$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Subaccount ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Subaccount; + } + export interface Params$Resource$Subaccounts$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Subaccount; + } + + export class Resource$Targetableremarketinglists { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.targetableRemarketingLists.get + * @desc Gets one remarketing list by ID. + * @alias dfareporting.targetableRemarketingLists.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Remarketing list ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Targetableremarketinglists$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Targetableremarketinglists$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Targetableremarketinglists$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Targetableremarketinglists$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetableremarketinglists$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetableremarketinglists$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/targetableRemarketingLists/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.targetableRemarketingLists.list + * @desc Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging. + * @alias dfareporting.targetableRemarketingLists.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.active Select only active or only inactive targetable remarketing lists. + * @param {string} params.advertiserId Select only targetable remarketing lists targetable by these advertisers. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.name Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list". + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Targetableremarketinglists$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Targetableremarketinglists$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback< + Schema$TargetableRemarketingListsListResponse + > + ): void; + list( + params: Params$Resource$Targetableremarketinglists$List, + callback: BodyResponseCallback< + Schema$TargetableRemarketingListsListResponse + > + ): void; + list( + callback: BodyResponseCallback< + Schema$TargetableRemarketingListsListResponse + > + ): void; + list( + paramsOrCallback?: + | Params$Resource$Targetableremarketinglists$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$TargetableRemarketingListsListResponse + > + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetableremarketinglists$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetableremarketinglists$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/targetableRemarketingLists' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'advertiserId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Targetableremarketinglists$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Remarketing list ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Targetableremarketinglists$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Select only active or only inactive targetable remarketing lists. + */ + active?: boolean; + /** + * Select only targetable remarketing lists targetable by these advertisers. + */ + advertiserId?: string; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list". + */ + name?: string; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + + export class Resource$Targetingtemplates { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.targetingTemplates.get + * @desc Gets one targeting template by ID. + * @alias dfareporting.targetingTemplates.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Targeting template ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Targetingtemplates$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Targetingtemplates$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Targetingtemplates$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Targetingtemplates$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetingtemplates$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetingtemplates$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/targetingTemplates/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.targetingTemplates.insert + * @desc Inserts a new targeting template. + * @alias dfareporting.targetingTemplates.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().TargetingTemplate} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Targetingtemplates$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Targetingtemplates$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Targetingtemplates$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Targetingtemplates$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetingtemplates$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetingtemplates$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/targetingTemplates' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.targetingTemplates.list + * @desc Retrieves a list of targeting templates, optionally filtered. This method supports paging. + * @alias dfareporting.targetingTemplates.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserId Select only targeting templates with this advertiser ID. + * @param {string=} params.ids Select only targeting templates with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "template*2015" will return objects with names like "template June 2015", "template April 2015", or simply "template 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "template" will match objects with name "my template", "template 2015", or simply "template". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Targetingtemplates$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Targetingtemplates$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Targetingtemplates$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Targetingtemplates$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetingtemplates$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetingtemplates$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/targetingTemplates' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * dfareporting.targetingTemplates.patch + * @desc Updates an existing targeting template. This method supports patch semantics. + * @alias dfareporting.targetingTemplates.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Targeting template ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().TargetingTemplate} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Targetingtemplates$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Targetingtemplates$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Targetingtemplates$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Targetingtemplates$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetingtemplates$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetingtemplates$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/targetingTemplates' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.targetingTemplates.update + * @desc Updates an existing targeting template. + * @alias dfareporting.targetingTemplates.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().TargetingTemplate} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Targetingtemplates$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Targetingtemplates$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Targetingtemplates$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Targetingtemplates$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetingtemplates$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetingtemplates$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/targetingTemplates' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Targetingtemplates$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Targeting template ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Targetingtemplates$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TargetingTemplate; + } + export interface Params$Resource$Targetingtemplates$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Select only targeting templates with this advertiser ID. + */ + advertiserId?: string; + /** + * Select only targeting templates with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "template*2015" will return objects with names like "template June 2015", "template April 2015", or simply "template 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "template" will match objects with name "my template", "template 2015", or simply "template". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Targetingtemplates$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Targeting template ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TargetingTemplate; + } + export interface Params$Resource$Targetingtemplates$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TargetingTemplate; + } + + export class Resource$Userprofiles { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.userProfiles.get + * @desc Gets one user profile by ID. + * @alias dfareporting.userProfiles.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId The user profile ID. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Userprofiles$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Userprofiles$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Userprofiles$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Userprofiles$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Userprofiles$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Userprofiles$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.userProfiles.list + * @desc Retrieves list of user profiles for a user. + * @alias dfareporting.userProfiles.list + * @memberOf! () + * + * @param {object=} params Parameters for request + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Userprofiles$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Userprofiles$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Userprofiles$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Userprofiles$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Userprofiles$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Userprofiles$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/dfareporting/v3.3/userprofiles').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Userprofiles$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The user profile ID. + */ + profileId?: string; + } + export interface Params$Resource$Userprofiles$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + } + + export class Resource$Userrolepermissiongroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.userRolePermissionGroups.get + * @desc Gets one user role permission group by ID. + * @alias dfareporting.userRolePermissionGroups.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id User role permission group ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Userrolepermissiongroups$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Userrolepermissiongroups$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Userrolepermissiongroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Userrolepermissiongroups$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Userrolepermissiongroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Userrolepermissiongroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/userRolePermissionGroups/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.userRolePermissionGroups.list + * @desc Gets a list of all supported user role permission groups. + * @alias dfareporting.userRolePermissionGroups.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Userrolepermissiongroups$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Userrolepermissiongroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback< + Schema$UserRolePermissionGroupsListResponse + > + ): void; + list( + params: Params$Resource$Userrolepermissiongroups$List, + callback: BodyResponseCallback< + Schema$UserRolePermissionGroupsListResponse + > + ): void; + list( + callback: BodyResponseCallback< + Schema$UserRolePermissionGroupsListResponse + > + ): void; + list( + paramsOrCallback?: + | Params$Resource$Userrolepermissiongroups$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$UserRolePermissionGroupsListResponse + > + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Userrolepermissiongroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Userrolepermissiongroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/userRolePermissionGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Userrolepermissiongroups$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User role permission group ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Userrolepermissiongroups$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Userrolepermissions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.userRolePermissions.get + * @desc Gets one user role permission by ID. + * @alias dfareporting.userRolePermissions.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id User role permission ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Userrolepermissions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Userrolepermissions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Userrolepermissions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Userrolepermissions$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Userrolepermissions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Userrolepermissions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/userRolePermissions/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.userRolePermissions.list + * @desc Gets a list of user role permissions, possibly filtered. + * @alias dfareporting.userRolePermissions.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.ids Select only user role permissions with these IDs. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Userrolepermissions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Userrolepermissions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Userrolepermissions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Userrolepermissions$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Userrolepermissions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Userrolepermissions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/userRolePermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Userrolepermissions$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User role permission ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Userrolepermissions$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Select only user role permissions with these IDs. + */ + ids?: string[]; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Userroles { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.userRoles.delete + * @desc Deletes an existing user role. + * @alias dfareporting.userRoles.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id User role ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Userroles$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Userroles$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Userroles$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Userroles$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Userroles$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Userroles$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/userRoles/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.userRoles.get + * @desc Gets one user role by ID. + * @alias dfareporting.userRoles.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id User role ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Userroles$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Userroles$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Userroles$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Userroles$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Userroles$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Userroles$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/userRoles/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.userRoles.insert + * @desc Inserts a new user role. + * @alias dfareporting.userRoles.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().UserRole} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Userroles$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Userroles$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Userroles$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Userroles$Insert + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Userroles$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Userroles$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/userRoles' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.userRoles.list + * @desc Retrieves a list of user roles, possibly filtered. This method supports paging. + * @alias dfareporting.userRoles.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.accountUserRoleOnly Select only account level user roles not associated with any specific subaccount. + * @param {string=} params.ids Select only user roles with the specified IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "userrole*2015" will return objects with names like "userrole June 2015", "userrole April 2015", or simply "userrole 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "userrole" will match objects with name "my userrole", "userrole 2015", or simply "userrole". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {string=} params.subaccountId Select only user roles that belong to this subaccount. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Userroles$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Userroles$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Userroles$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Userroles$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Userroles$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Userroles$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/userRoles' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.userRoles.patch + * @desc Updates an existing user role. This method supports patch semantics. + * @alias dfareporting.userRoles.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id User role ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().UserRole} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Userroles$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Userroles$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Userroles$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Userroles$Patch + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Userroles$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Userroles$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/userRoles' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.userRoles.update + * @desc Updates an existing user role. + * @alias dfareporting.userRoles.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().UserRole} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Userroles$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Userroles$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Userroles$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Userroles$Update + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Userroles$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Userroles$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/userRoles' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Userroles$Delete extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User role ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Userroles$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User role ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Userroles$Insert extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UserRole; + } + export interface Params$Resource$Userroles$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Select only account level user roles not associated with any specific subaccount. + */ + accountUserRoleOnly?: boolean; + /** + * Select only user roles with the specified IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "userrole*2015" will return objects with names like "userrole June 2015", "userrole April 2015", or simply "userrole 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "userrole" will match objects with name "my userrole", "userrole 2015", or simply "userrole". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + /** + * Select only user roles that belong to this subaccount. + */ + subaccountId?: string; + } + export interface Params$Resource$Userroles$Patch extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User role ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UserRole; + } + export interface Params$Resource$Userroles$Update extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UserRole; + } + + export class Resource$Videoformats { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dfareporting.videoFormats.get + * @desc Gets one video format by ID. + * @alias dfareporting.videoFormats.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer} params.id Video format ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Videoformats$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Videoformats$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Videoformats$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Videoformats$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Videoformats$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Videoformats$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/videoFormats/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dfareporting.videoFormats.list + * @desc Lists available video formats. + * @alias dfareporting.videoFormats.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Videoformats$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Videoformats$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Videoformats$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Videoformats$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Videoformats$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Videoformats$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/videoFormats' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Videoformats$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Video format ID. + */ + id?: number; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Videoformats$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + } +} diff --git a/src/apis/dfareporting/v3.4.ts b/src/apis/dfareporting/v3.4.ts index 6c614cffd87..736623b3526 100644 --- a/src/apis/dfareporting/v3.4.ts +++ b/src/apis/dfareporting/v3.4.ts @@ -914,19 +914,6 @@ export namespace dfareporting_v3_4 { */ nextPageToken?: string | null; } - /** - * Annotate a click event. - */ - export interface Schema$AnnotateClickEvent { - /** - * The Google click ID. Use this field to annotate the click associated with the gclid. - */ - gclid?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#annotateClickEvent". - */ - kind?: string | null; - } /** * Audience Segment. */ @@ -2622,11 +2609,11 @@ export namespace dfareporting_v3_4 { /** * Annotate a click event. */ - annotateClickEvent?: Schema$AnnotateClickEvent; + annotateClickEvent?: Schema$CustomEventClickAnnotation; /** * Custom variables associated with the event. */ - customVariables?: Schema$CustomVariables[]; + customVariables?: Schema$CustomVariable[]; /** * The type of event. If INSERT, the fields in insertEvent need to be populated. If ANNOTATE_CLICK, the fields in annotateClickEvent need to be populated. A custom event cannot have both insertEvent and annotateClickEvent populated. */ @@ -2638,7 +2625,7 @@ export namespace dfareporting_v3_4 { /** * Insert custom event. */ - insertEvent?: Schema$InsertEvent; + insertEvent?: Schema$CustomEventInsert; /** * Identifies what kind of resource this is. Value: the fixed string "dfareporting#customEvent". */ @@ -2652,6 +2639,19 @@ export namespace dfareporting_v3_4 { */ timestampMicros?: string | null; } + /** + * Annotate a click event. + */ + export interface Schema$CustomEventClickAnnotation { + /** + * The Google click ID. Use this field to annotate the click associated with the gclid. + */ + gclid?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#customEventClickAnnotation". + */ + kind?: string | null; + } /** * The error code and description for a custom event that failed to insert. */ @@ -2669,6 +2669,35 @@ export namespace dfareporting_v3_4 { */ message?: string | null; } + /** + * Custom event to be inserted. + */ + export interface Schema$CustomEventInsert { + /** + * Campaign Manager dimensions associated with the event. + */ + cmDimensions?: Schema$CampaignManagerIds; + /** + * DV360 dimensions associated with the event. + */ + dv3Dimensions?: Schema$DV3Ids; + /** + * The type of event to insert. + */ + insertEventType?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#customEventInsert". + */ + kind?: string | null; + /** + * The match ID field. A match ID is your own first-party identifier that has been synced with Google using the match ID feature in Floodlight. This field is mutually exclusive with mobileDeviceId, and at least one of the two fields is required. + */ + matchId?: string | null; + /** + * The mobile device ID. This field is mutually exclusive with matchId, and at least one of the two fields is required. + */ + mobileDeviceId?: string | null; + } /** * Insert Custom Events Request. */ @@ -2747,15 +2776,15 @@ export namespace dfareporting_v3_4 { kind?: string | null; } /** - * A custom variable. + * Custom variable. */ - export interface Schema$CustomVariables { + export interface Schema$CustomVariable { /** * The index of the custom variable. */ index?: string | null; /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#customVariables". + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#customVariable". */ kind?: string | null; /** @@ -3826,35 +3855,6 @@ export namespace dfareporting_v3_4 { */ regions?: Schema$Region[]; } - /** - * Insert custom event. - */ - export interface Schema$InsertEvent { - /** - * Campaign Manager dimensions associated with the event. - */ - cmDimensions?: Schema$CampaignManagerIds; - /** - * DV360 dimensions associated with the event. - */ - dv3Dimensions?: Schema$DV3Ids; - /** - * The type of insert event. - */ - insertEventType?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#insertEvent". - */ - kind?: string | null; - /** - * The match ID field. A match ID is your own first-party identifier that has been synced with Google using the match ID feature in Floodlight. This field is mutually exclusive with mobileDeviceId, and at least one of the two fields is required. - */ - matchId?: string | null; - /** - * The mobile device ID. This field is mutually exclusive with matchId, and at least one of the two fields is required. - */ - mobileDeviceId?: string | null; - } /** * Represents a buy from the Planning inventory store. */ diff --git a/src/apis/dlp/v2.ts b/src/apis/dlp/v2.ts index 725267c9328..546128db379 100644 --- a/src/apis/dlp/v2.ts +++ b/src/apis/dlp/v2.ts @@ -126,7 +126,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2Action { /** - * Enable email notification to project owners and editors on job's completion/failure. + * Enable email notification for project owners and editors on job's completion/failure. */ jobNotificationEmails?: Schema$GooglePrivacyDlpV2JobNotificationEmails; /** @@ -158,11 +158,29 @@ export namespace dlp_v2 { * Result of a risk analysis operation request. */ export interface Schema$GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails { + /** + * Categorical stats result + */ categoricalStatsResult?: Schema$GooglePrivacyDlpV2CategoricalStatsResult; + /** + * Delta-presence result + */ deltaPresenceEstimationResult?: Schema$GooglePrivacyDlpV2DeltaPresenceEstimationResult; + /** + * K-anonymity result + */ kAnonymityResult?: Schema$GooglePrivacyDlpV2KAnonymityResult; + /** + * K-map result + */ kMapEstimationResult?: Schema$GooglePrivacyDlpV2KMapEstimationResult; + /** + * L-divesity result + */ lDiversityResult?: Schema$GooglePrivacyDlpV2LDiversityResult; + /** + * Numerical stats result + */ numericalStatsResult?: Schema$GooglePrivacyDlpV2NumericalStatsResult; /** * Privacy metric to compute. @@ -178,15 +196,15 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2AuxiliaryTable { /** - * Quasi-identifier columns. [required] + * Required. Quasi-identifier columns. */ quasiIds?: Schema$GooglePrivacyDlpV2QuasiIdField[]; /** - * The relative frequency column must contain a floating-point number between 0 and 1 (inclusive). Null values are assumed to be zero. [required] + * Required. The relative frequency column must contain a floating-point number between 0 and 1 (inclusive). Null values are assumed to be zero. */ relativeFrequency?: Schema$GooglePrivacyDlpV2FieldId; /** - * Auxiliary table location. [required] + * Required. Auxiliary table location. */ table?: Schema$GooglePrivacyDlpV2BigQueryTable; } @@ -332,6 +350,9 @@ export namespace dlp_v2 { */ field?: Schema$GooglePrivacyDlpV2FieldId; } + /** + * Histogram of value frequencies in the column. + */ export interface Schema$GooglePrivacyDlpV2CategoricalStatsHistogramBucket { /** * Total number of values in this bucket. @@ -388,7 +409,13 @@ export namespace dlp_v2 { * Characters to skip when doing deidentification of a value. These will be left alone and skipped. */ export interface Schema$GooglePrivacyDlpV2CharsToIgnore { + /** + * Characters to not transform when masking. + */ charactersToSkip?: string | null; + /** + * Common characters to not transform when masking. Useful to avoid removing punctuation. + */ commonCharactersToIgnore?: string | null; } /** @@ -474,15 +501,15 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2Condition { /** - * Field within the record this condition is evaluated against. [required] + * Required. Field within the record this condition is evaluated against. */ field?: Schema$GooglePrivacyDlpV2FieldId; /** - * Operator used to compare the field or infoType to the value. [required] + * Required. Operator used to compare the field or infoType to the value. */ operator?: string | null; /** - * Value to compare against. [Required, except for `EXISTS` tests.] + * Value to compare against. [Mandatory, except for `EXISTS` tests.] */ value?: Schema$GooglePrivacyDlpV2Value; } @@ -490,6 +517,9 @@ export namespace dlp_v2 { * A collection of conditions. */ export interface Schema$GooglePrivacyDlpV2Conditions { + /** + * A collection of conditions. + */ conditions?: Schema$GooglePrivacyDlpV2Condition[]; } /** @@ -514,7 +544,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2ContentLocation { /** - * Name of the container where the finding is located. The top level name is the source file name or table name. Names of some common storage containers are formatted as follows: * BigQuery tables: `<project_id>:<dataset_id>.<table_id>` * Cloud Storage files: `gs://<bucket>/<path>` * Datastore namespace: <namespace> Nested names could be absent if the embedded object has no string identifier (for an example an image contained within a document). + * Name of the container where the finding is located. The top level name is the source file name or table name. Names of some common storage containers are formatted as follows: * BigQuery tables: `{project_id}:{dataset_id}.{table_id}` * Cloud Storage files: `gs://{bucket}/{path}` * Datastore namespace: {namespace} Nested names could be absent if the embedded object has no string identifier (for an example an image contained within a document). */ containerName?: string | null; /** @@ -543,7 +573,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2CreateDeidentifyTemplateRequest { /** - * The DeidentifyTemplate to create. + * Required. The DeidentifyTemplate to create. */ deidentifyTemplate?: Schema$GooglePrivacyDlpV2DeidentifyTemplate; /** @@ -559,6 +589,9 @@ export namespace dlp_v2 { * Request message for CreateDlpJobRequest. Used to initiate long running jobs such as calculating risk metrics or inspecting Google Cloud Storage. */ export interface Schema$GooglePrivacyDlpV2CreateDlpJobRequest { + /** + * Set to control what and how to inspect. + */ inspectJob?: Schema$GooglePrivacyDlpV2InspectJobConfig; /** * The job id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one. @@ -568,6 +601,9 @@ export namespace dlp_v2 { * The geographic location to store and process the job. Reserved for future extensions. */ locationId?: string | null; + /** + * Set to choose what metric to calculate. + */ riskJob?: Schema$GooglePrivacyDlpV2RiskAnalysisJobConfig; } /** @@ -575,7 +611,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2CreateInspectTemplateRequest { /** - * The InspectTemplate to create. + * Required. The InspectTemplate to create. */ inspectTemplate?: Schema$GooglePrivacyDlpV2InspectTemplate; /** @@ -592,7 +628,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2CreateJobTriggerRequest { /** - * The JobTrigger to create. + * Required. The JobTrigger to create. */ jobTrigger?: Schema$GooglePrivacyDlpV2JobTrigger; /** @@ -609,7 +645,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2CreateStoredInfoTypeRequest { /** - * Configuration of the storedInfoType to create. + * Required. Configuration of the storedInfoType to create. */ config?: Schema$GooglePrivacyDlpV2StoredInfoTypeConfig; /** @@ -626,7 +662,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2CryptoDeterministicConfig { /** - * Optional. A context may be used for higher security and maintaining referential integrity such that the same identifier in two different contexts will be given a distinct surrogate. The context is appended to plaintext value being encrypted. On decryption the provided context is validated against the value used during encryption. If a context was provided during encryption, same context must be provided during decryption as well. If the context is not set, plaintext would be used as is for encryption. If the context is set but: 1. there is no record present when transforming a given value or 2. the field is not present when transforming a given value, plaintext would be used as is for encryption. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and non-structured `ContentItem`s. + * A context may be used for higher security and maintaining referential integrity such that the same identifier in two different contexts will be given a distinct surrogate. The context is appended to plaintext value being encrypted. On decryption the provided context is validated against the value used during encryption. If a context was provided during encryption, same context must be provided during decryption as well. If the context is not set, plaintext would be used as is for encryption. If the context is set but: 1. there is no record present when transforming a given value or 2. the field is not present when transforming a given value, plaintext would be used as is for encryption. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and non-structured `ContentItem`s. */ context?: Schema$GooglePrivacyDlpV2FieldId; /** @@ -634,7 +670,7 @@ export namespace dlp_v2 { */ cryptoKey?: Schema$GooglePrivacyDlpV2CryptoKey; /** - * The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: <info type name>(<surrogate character count>):<surrogate> For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are optional to use. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE. + * The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE. */ surrogateInfoType?: Schema$GooglePrivacyDlpV2InfoType; } @@ -651,21 +687,33 @@ export namespace dlp_v2 { * This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by KMS). When using KMS to wrap/unwrap DEKs, be sure to set an appropriate IAM policy on the KMS CryptoKey (KEK) to ensure an attacker cannot unwrap the data crypto key. */ export interface Schema$GooglePrivacyDlpV2CryptoKey { + /** + * Kms wrapped key + */ kmsWrapped?: Schema$GooglePrivacyDlpV2KmsWrappedCryptoKey; + /** + * Transient crypto key + */ transient?: Schema$GooglePrivacyDlpV2TransientCryptoKey; + /** + * Unwrapped crypto key + */ unwrapped?: Schema$GooglePrivacyDlpV2UnwrappedCryptoKey; } /** * Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/dlp/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. */ export interface Schema$GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig { + /** + * Common alphabets. + */ commonAlphabet?: string | null; /** * The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and non-structured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2 */ context?: Schema$GooglePrivacyDlpV2FieldId; /** - * The key used by the encryption algorithm. [required] + * Required. The key used by the encryption algorithm. */ cryptoKey?: Schema$GooglePrivacyDlpV2CryptoKey; /** @@ -753,11 +801,11 @@ export namespace dlp_v2 { */ cryptoKey?: Schema$GooglePrivacyDlpV2CryptoKey; /** - * For example, -5 means shift date to at most 5 days back in the past. [Required] + * Required. For example, -5 means shift date to at most 5 days back in the past. */ lowerBoundDays?: number | null; /** - * Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. [Required] + * Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future. */ upperBoundDays?: number | null; } @@ -766,11 +814,20 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2DateTime { /** - * One or more of the following must be set. All fields are optional, but when set must be valid date or time values. + * One or more of the following must be set. Must be a valid date or time value. */ date?: Schema$GoogleTypeDate; + /** + * Day of week + */ dayOfWeek?: string | null; + /** + * Time of day + */ time?: Schema$GoogleTypeTimeOfDay; + /** + * Time zone + */ timeZone?: Schema$GooglePrivacyDlpV2TimeZone; } /** @@ -785,6 +842,10 @@ export namespace dlp_v2 { * Treat the dataset as structured. Transformations can be applied to specific locations within structured datasets, such as transforming a column within a table. */ recordTransformations?: Schema$GooglePrivacyDlpV2RecordTransformations; + /** + * Mode for handling transformation errors. If left unspecified, the default mode is `TransformationErrorHandling.ThrowError`. + */ + transformationErrorHandling?: Schema$GooglePrivacyDlpV2TransformationErrorHandling; } /** * Request to de-identify a list of items. @@ -795,7 +856,7 @@ export namespace dlp_v2 { */ deidentifyConfig?: Schema$GooglePrivacyDlpV2DeidentifyConfig; /** - * Optional template to use. Any configuration directly specified in deidentify_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged. + * Template to use. Any configuration directly specified in deidentify_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged. */ deidentifyTemplateName?: string | null; /** @@ -803,7 +864,7 @@ export namespace dlp_v2 { */ inspectConfig?: Schema$GooglePrivacyDlpV2InspectConfig; /** - * Optional template to use. Any configuration directly specified in inspect_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged. + * Template to use. Any configuration directly specified in inspect_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged. */ inspectTemplateName?: string | null; /** @@ -833,7 +894,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2DeidentifyTemplate { /** - * The creation timestamp of an inspectTemplate, output only field. + * Output only. The creation timestamp of an inspectTemplate. */ createTime?: string | null; /** @@ -849,11 +910,11 @@ export namespace dlp_v2 { */ displayName?: string | null; /** - * The template name. Output only. The template will have one of the following formats: `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID` + * Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID` */ name?: string | null; /** - * The last update timestamp of an inspectTemplate, output only field. + * Output only. The last update timestamp of an inspectTemplate. */ updateTime?: string | null; } @@ -866,11 +927,11 @@ export namespace dlp_v2 { */ auxiliaryTables?: Schema$GooglePrivacyDlpV2StatisticalTable[]; /** - * Fields considered to be quasi-identifiers. No two fields can have the same tag. [required] + * Required. Fields considered to be quasi-identifiers. No two fields can have the same tag. */ quasiIds?: Schema$GooglePrivacyDlpV2QuasiId[]; /** - * ISO 3166-1 alpha-2 region code to use in the statistical modeling. Required if no column is tagged with a region-specific InfoType (like US_ZIP_5) or a region code. + * ISO 3166-1 alpha-2 region code to use in the statistical modeling. Set if no column is tagged with a region-specific InfoType (like US_ZIP_5) or a region code. */ regionCode?: string | null; } @@ -1007,9 +1068,12 @@ export namespace dlp_v2 { field?: Schema$GooglePrivacyDlpV2FieldId; } /** - * Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger. Output only field. + * Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger. */ export interface Schema$GooglePrivacyDlpV2Error { + /** + * Detailed error codes and messages. + */ details?: Schema$GoogleRpcStatus; /** * The times the error occurred. @@ -1050,6 +1114,9 @@ export namespace dlp_v2 { * An expression, consisting or an operator and conditions. */ export interface Schema$GooglePrivacyDlpV2Expressions { + /** + * Conditions to apply to the expression. + */ conditions?: Schema$GooglePrivacyDlpV2Conditions; /** * The operator to apply to the result of conditions. Default and currently only supported value is `AND`. @@ -1070,11 +1137,11 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2FieldTransformation { /** - * Only apply the transformation if the condition evaluates to true for the given `RecordCondition`. The conditions are allowed to reference fields that are not used in the actual transformation. [optional] Example Use Cases: - Apply a different bucket transformation to an age column if the zip code column for the same record is within a specific range. - Redact a field if the date of birth field is greater than 85. + * Only apply the transformation if the condition evaluates to true for the given `RecordCondition`. The conditions are allowed to reference fields that are not used in the actual transformation. Example Use Cases: - Apply a different bucket transformation to an age column if the zip code column for the same record is within a specific range. - Redact a field if the date of birth field is greater than 85. */ condition?: Schema$GooglePrivacyDlpV2RecordCondition; /** - * Input field(s) to apply the transformation to. [required] + * Required. Input field(s) to apply the transformation to. */ fields?: Schema$GooglePrivacyDlpV2FieldId[]; /** @@ -1128,6 +1195,9 @@ export namespace dlp_v2 { */ quoteInfo?: Schema$GooglePrivacyDlpV2QuoteInfo; } + /** + * Configuration to control the number of findings returned. + */ export interface Schema$GooglePrivacyDlpV2FindingLimits { /** * Configuration of findings limit given for specified infoTypes. @@ -1143,19 +1213,19 @@ export namespace dlp_v2 { maxFindingsPerRequest?: number | null; } /** - * Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of <lower_bound>-<upper_bound>, i.e if lower_bound = 10 and upper_bound = 20 all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/dlp/docs/concepts-bucketing to learn more. + * Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}, i.e if lower_bound = 10 and upper_bound = 20 all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/dlp/docs/concepts-bucketing to learn more. */ export interface Schema$GooglePrivacyDlpV2FixedSizeBucketingConfig { /** - * Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. [Required]. + * Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. */ bucketSize?: number | null; /** - * Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value “-10”. [Required]. + * Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value “-10”. */ lowerBound?: Schema$GooglePrivacyDlpV2Value; /** - * Upper bound value of buckets. All values greater than upper_bound are grouped together into a single bucket; for example if `upper_bound` = 89, then all values greater than 89 are replaced with the value “89+”. [Required]. + * Required. Upper bound value of buckets. All values greater than upper_bound are grouped together into a single bucket; for example if `upper_bound` = 89, then all values greater than 89 are replaced with the value “89+”. */ upperBound?: Schema$GooglePrivacyDlpV2Value; } @@ -1267,7 +1337,7 @@ export namespace dlp_v2 { */ infoTypes?: Schema$GooglePrivacyDlpV2InfoType[]; /** - * Primitive transformation to apply to the infoType. [required] + * Required. Primitive transformation to apply to the infoType. */ primitiveTransformation?: Schema$GooglePrivacyDlpV2PrimitiveTransformation; } @@ -1276,7 +1346,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2InfoTypeTransformations { /** - * Transformation for each infoType. Cannot specify more than one for a given infoType. [required] + * Required. Transformation for each infoType. Cannot specify more than one for a given infoType. */ transformations?: Schema$GooglePrivacyDlpV2InfoTypeTransformation[]; } @@ -1304,6 +1374,9 @@ export namespace dlp_v2 { * Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://cloud.google.com/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference, otherwise a default list will be used, which may change over time. */ infoTypes?: Schema$GooglePrivacyDlpV2InfoType[]; + /** + * Configuration to control the number of findings returned. + */ limits?: Schema$GooglePrivacyDlpV2FindingLimits; /** * Only returns findings equal or above this threshold. The default is POSSIBLE. See https://cloud.google.com/dlp/docs/likelihood to learn more. @@ -1323,7 +1396,7 @@ export namespace dlp_v2 { */ inspectConfig?: Schema$GooglePrivacyDlpV2InspectConfig; /** - * Optional template to use. Any configuration directly specified in inspect_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged. + * Template to use. Any configuration directly specified in inspect_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged. */ inspectTemplateName?: string | null; /** @@ -1383,6 +1456,9 @@ export namespace dlp_v2 { */ rules?: Schema$GooglePrivacyDlpV2InspectionRule[]; } + /** + * Controls what and how to inspect for findings. + */ export interface Schema$GooglePrivacyDlpV2InspectJobConfig { /** * Actions to execute at the completion of the job. @@ -1419,7 +1495,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2InspectTemplate { /** - * The creation timestamp of an inspectTemplate, output only field. + * Output only. The creation timestamp of an inspectTemplate. */ createTime?: string | null; /** @@ -1435,11 +1511,11 @@ export namespace dlp_v2 { */ inspectConfig?: Schema$GooglePrivacyDlpV2InspectConfig; /** - * The template name. Output only. The template will have one of the following formats: `projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID` + * Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID`; */ name?: string | null; /** - * The last update timestamp of an inspectTemplate, output only field. + * Output only. The last update timestamp of an inspectTemplate. */ updateTime?: string | null; } @@ -1452,7 +1528,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2JobTrigger { /** - * The creation timestamp of a triggeredJob, output only field. + * Output only. The creation timestamp of a triggeredJob. */ createTime?: string | null; /** @@ -1464,12 +1540,15 @@ export namespace dlp_v2 { */ displayName?: string | null; /** - * A stream of errors encountered when the trigger was activated. Repeated errors may result in the JobTrigger automatically being paused. Will return the last 100 errors. Whenever the JobTrigger is modified this list will be cleared. Output only field. + * Output only. A stream of errors encountered when the trigger was activated. Repeated errors may result in the JobTrigger automatically being paused. Will return the last 100 errors. Whenever the JobTrigger is modified this list will be cleared. */ errors?: Schema$GooglePrivacyDlpV2Error[]; + /** + * For inspect jobs, a snapshot of the configuration. + */ inspectJob?: Schema$GooglePrivacyDlpV2InspectJobConfig; /** - * The timestamp of the last time this trigger executed, output only field. + * Output only. The timestamp of the last time this trigger executed. */ lastRunTime?: string | null; /** @@ -1477,7 +1556,7 @@ export namespace dlp_v2 { */ name?: string | null; /** - * A status for this trigger. [required] + * Required. A status for this trigger. */ status?: string | null; /** @@ -1485,7 +1564,7 @@ export namespace dlp_v2 { */ triggers?: Schema$GooglePrivacyDlpV2Trigger[]; /** - * The last update timestamp of a triggeredJob, output only field. + * Output only. The last update timestamp of a triggeredJob. */ updateTime?: string | null; } @@ -1494,7 +1573,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2KAnonymityConfig { /** - * Optional message indicating that multiple rows might be associated to a single individual. If the same entity_id is associated to multiple quasi-identifier tuples over distinct rows, we consider the entire collection of tuples as the composite quasi-identifier. This collection is a multiset: the order in which the different tuples appear in the dataset is ignored, but their frequency is taken into account. Important note: a maximum of 1000 rows can be associated to a single entity ID. If more rows are associated with the same entity ID, some might be ignored. + * Message indicating that multiple rows might be associated to a single individual. If the same entity_id is associated to multiple quasi-identifier tuples over distinct rows, we consider the entire collection of tuples as the composite quasi-identifier. This collection is a multiset: the order in which the different tuples appear in the dataset is ignored, but their frequency is taken into account. Important note: a maximum of 1000 rows can be associated to a single entity ID. If more rows are associated with the same entity ID, some might be ignored. */ entityId?: Schema$GooglePrivacyDlpV2EntityId; /** @@ -1515,6 +1594,9 @@ export namespace dlp_v2 { */ quasiIdsValues?: Schema$GooglePrivacyDlpV2Value[]; } + /** + * Histogram of k-anonymity equivalence classes. + */ export interface Schema$GooglePrivacyDlpV2KAnonymityHistogramBucket { /** * Total number of equivalence classes in this bucket. @@ -1569,7 +1651,7 @@ export namespace dlp_v2 { name?: string | null; } /** - * Reidentifiability metric. This corresponds to a risk model similar to what is called "journalist risk" in the literature, except the attack dataset is statistically modeled instead of being perfectly known. This can be done using publicly available data (like the US Census), or using a custom statistical model (indicated as one or several BigQuery tables), or by extrapolating from the distribution of values in the input dataset. A column with a semantic tag attached. + * Reidentifiability metric. This corresponds to a risk model similar to what is called "journalist risk" in the literature, except the attack dataset is statistically modeled instead of being perfectly known. This can be done using publicly available data (like the US Census), or using a custom statistical model (indicated as one or several BigQuery tables), or by extrapolating from the distribution of values in the input dataset. */ export interface Schema$GooglePrivacyDlpV2KMapEstimationConfig { /** @@ -1577,11 +1659,11 @@ export namespace dlp_v2 { */ auxiliaryTables?: Schema$GooglePrivacyDlpV2AuxiliaryTable[]; /** - * Fields considered to be quasi-identifiers. No two columns can have the same tag. [required] + * Required. Fields considered to be quasi-identifiers. No two columns can have the same tag. */ quasiIds?: Schema$GooglePrivacyDlpV2TaggedField[]; /** - * ISO 3166-1 alpha-2 region code to use in the statistical modeling. Required if no column is tagged with a region-specific InfoType (like US_ZIP_5) or a region code. + * ISO 3166-1 alpha-2 region code to use in the statistical modeling. Set if no column is tagged with a region-specific InfoType (like US_ZIP_5) or a region code. */ regionCode?: string | null; } @@ -1637,11 +1719,11 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2KmsWrappedCryptoKey { /** - * The resource name of the KMS CryptoKey to use for unwrapping. [required] + * Required. The resource name of the KMS CryptoKey to use for unwrapping. */ cryptoKeyName?: string | null; /** - * The wrapped data crypto key. [required] + * Required. The wrapped data crypto key. */ wrappedKey?: string | null; } @@ -1705,6 +1787,9 @@ export namespace dlp_v2 { */ topSensitiveValues?: Schema$GooglePrivacyDlpV2ValueFrequency[]; } + /** + * Histogram of l-diversity equivalence class sensitive value frequencies. + */ export interface Schema$GooglePrivacyDlpV2LDiversityHistogramBucket { /** * Total number of equivalence classes in this bucket. @@ -1736,6 +1821,10 @@ export namespace dlp_v2 { */ sensitiveValueFrequencyHistogramBuckets?: Schema$GooglePrivacyDlpV2LDiversityHistogramBucket[]; } + /** + * Skips the data without modifying it if the requested transformation would cause an error. For example, if a `DateShift` transformation were applied an an IP address, this mode would leave the IP address unchanged in the response. + */ + export interface Schema$GooglePrivacyDlpV2LeaveUntransformed {} /** * Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. */ @@ -1913,27 +2002,78 @@ export namespace dlp_v2 { * A rule for transforming a value. */ export interface Schema$GooglePrivacyDlpV2PrimitiveTransformation { + /** + * Bucketing + */ bucketingConfig?: Schema$GooglePrivacyDlpV2BucketingConfig; + /** + * Mask + */ characterMaskConfig?: Schema$GooglePrivacyDlpV2CharacterMaskConfig; + /** + * Deterministic Crypto + */ cryptoDeterministicConfig?: Schema$GooglePrivacyDlpV2CryptoDeterministicConfig; + /** + * Crypto + */ cryptoHashConfig?: Schema$GooglePrivacyDlpV2CryptoHashConfig; + /** + * Ffx-Fpe + */ cryptoReplaceFfxFpeConfig?: Schema$GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig; + /** + * Date Shift + */ dateShiftConfig?: Schema$GooglePrivacyDlpV2DateShiftConfig; + /** + * Fixed size bucketing + */ fixedSizeBucketingConfig?: Schema$GooglePrivacyDlpV2FixedSizeBucketingConfig; + /** + * Redact + */ redactConfig?: Schema$GooglePrivacyDlpV2RedactConfig; + /** + * Replace + */ replaceConfig?: Schema$GooglePrivacyDlpV2ReplaceValueConfig; + /** + * Replace with infotype + */ replaceWithInfoTypeConfig?: Schema$GooglePrivacyDlpV2ReplaceWithInfoTypeConfig; + /** + * Time extraction + */ timePartConfig?: Schema$GooglePrivacyDlpV2TimePartConfig; } /** * Privacy metric to compute for reidentification risk analysis. */ export interface Schema$GooglePrivacyDlpV2PrivacyMetric { + /** + * Categorical stats + */ categoricalStatsConfig?: Schema$GooglePrivacyDlpV2CategoricalStatsConfig; + /** + * delta-presence + */ deltaPresenceEstimationConfig?: Schema$GooglePrivacyDlpV2DeltaPresenceEstimationConfig; + /** + * K-anonymity + */ kAnonymityConfig?: Schema$GooglePrivacyDlpV2KAnonymityConfig; + /** + * k-map + */ kMapEstimationConfig?: Schema$GooglePrivacyDlpV2KMapEstimationConfig; + /** + * l-diversity + */ lDiversityConfig?: Schema$GooglePrivacyDlpV2LDiversityConfig; + /** + * Numerical stats + */ numericalStatsConfig?: Schema$GooglePrivacyDlpV2NumericalStatsConfig; } /** @@ -1979,7 +2119,7 @@ export namespace dlp_v2 { */ customTag?: string | null; /** - * Identifies the column. [required] + * Required. Identifies the column. */ field?: Schema$GooglePrivacyDlpV2FieldId; /** @@ -1995,14 +2135,26 @@ export namespace dlp_v2 { * A quasi-identifier column has a custom_tag, used to know which column in the data corresponds to which column in the statistical model. */ export interface Schema$GooglePrivacyDlpV2QuasiIdentifierField { + /** + * A column can be tagged with a custom tag. In this case, the user must indicate an auxiliary table that contains statistical information on the possible values of this column (below). + */ customTag?: string | null; + /** + * Identifies the column. + */ field?: Schema$GooglePrivacyDlpV2FieldId; } /** * A quasi-identifier column has a custom_tag, used to know which column in the data corresponds to which column in the statistical model. */ export interface Schema$GooglePrivacyDlpV2QuasiIdField { + /** + * A auxiliary field. + */ customTag?: string | null; + /** + * Identifies the column. + */ field?: Schema$GooglePrivacyDlpV2FieldId; } /** @@ -2082,7 +2234,7 @@ export namespace dlp_v2 { */ fieldTransformations?: Schema$GooglePrivacyDlpV2FieldTransformation[]; /** - * Configuration defining which records get suppressed entirely. Records that match any suppression rule are omitted from the output [optional]. + * Configuration defining which records get suppressed entirely. Records that match any suppression rule are omitted from the output. */ recordSuppressions?: Schema$GooglePrivacyDlpV2RecordSuppression[]; } @@ -2154,7 +2306,7 @@ export namespace dlp_v2 { */ inspectConfig?: Schema$GooglePrivacyDlpV2InspectConfig; /** - * Optional template to use. Any configuration directly specified in `inspect_config` will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged. + * Template to use. Any configuration directly specified in `inspect_config` will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged. */ inspectTemplateName?: string | null; /** @@ -2170,7 +2322,7 @@ export namespace dlp_v2 { */ reidentifyConfig?: Schema$GooglePrivacyDlpV2DeidentifyConfig; /** - * Optional template to use. References an instance of `DeidentifyTemplate`. Any configuration directly specified in `reidentify_config` or `inspect_config` will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged. + * Template to use. References an instance of `DeidentifyTemplate`. Any configuration directly specified in `reidentify_config` or `inspect_config` will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged. */ reidentifyTemplateName?: string | null; } @@ -2200,7 +2352,13 @@ export namespace dlp_v2 { * Replace each matching finding with the name of the info_type. */ export interface Schema$GooglePrivacyDlpV2ReplaceWithInfoTypeConfig {} + /** + * Snapshot of the inspection configuration. + */ export interface Schema$GooglePrivacyDlpV2RequestedOptions { + /** + * Inspect config. + */ jobConfig?: Schema$GooglePrivacyDlpV2InspectJobConfig; /** * If run with an InspectTemplate, a snapshot of its state at the time of this run. @@ -2241,13 +2399,22 @@ export namespace dlp_v2 { */ sourceTable?: Schema$GooglePrivacyDlpV2BigQueryTable; } + /** + * Values of the row. + */ export interface Schema$GooglePrivacyDlpV2Row { + /** + * Individual cells. + */ values?: Schema$GooglePrivacyDlpV2Value[]; } /** * If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk */ export interface Schema$GooglePrivacyDlpV2SaveFindings { + /** + * Location to store findings outside of DLP. + */ outputConfig?: Schema$GooglePrivacyDlpV2OutputStorageConfig; } /** @@ -2264,15 +2431,15 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2StatisticalTable { /** - * Quasi-identifier columns. [required] + * Required. Quasi-identifier columns. */ quasiIds?: Schema$GooglePrivacyDlpV2QuasiIdentifierField[]; /** - * The relative frequency column must contain a floating-point number between 0 and 1 (inclusive). Null values are assumed to be zero. [required] + * Required. The relative frequency column must contain a floating-point number between 0 and 1 (inclusive). Null values are assumed to be zero. */ relativeFrequency?: Schema$GooglePrivacyDlpV2FieldId; /** - * Auxiliary table location. [required] + * Required. Auxiliary table location. */ table?: Schema$GooglePrivacyDlpV2BigQueryTable; } @@ -2312,7 +2479,7 @@ export namespace dlp_v2 { pendingVersions?: Schema$GooglePrivacyDlpV2StoredInfoTypeVersion[]; } /** - * Configuration for stored infoT types. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/dlp/docs/creating-custom-infotypes. + * Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/dlp/docs/creating-custom-infotypes. */ export interface Schema$GooglePrivacyDlpV2StoredInfoTypeConfig { /** @@ -2350,7 +2517,7 @@ export namespace dlp_v2 { */ createTime?: string | null; /** - * Errors that occurred when creating this storedInfoType version, or anomalies detected in the storedInfoType data that render it unusable. Only the five most recent errors will be displayed, with the most recent error appearing first. <p>For example, some of the data for stored custom dictionaries is put in the user's Google Cloud Storage bucket, and if this data is modified or deleted by the user or another system, the dictionary becomes invalid. <p>If any errors occur, fix the problem indicated by the error message and use the UpdateStoredInfoType API method to create another version of the storedInfoType to continue using it, reusing the same `config` if it was not the source of the error. + * Errors that occurred when creating this storedInfoType version, or anomalies detected in the storedInfoType data that render it unusable. Only the five most recent errors will be displayed, with the most recent error appearing first. For example, some of the data for stored custom dictionaries is put in the user's Google Cloud Storage bucket, and if this data is modified or deleted by the user or another system, the dictionary becomes invalid. If any errors occur, fix the problem indicated by the error message and use the UpdateStoredInfoType API method to create another version of the storedInfoType to continue using it, reusing the same `config` if it was not the source of the error. */ errors?: Schema$GooglePrivacyDlpV2Error[]; /** @@ -2379,7 +2546,13 @@ export namespace dlp_v2 { * A collection that informs the user the number of times a particular `TransformationResultCode` and error details occurred. */ export interface Schema$GooglePrivacyDlpV2SummaryResult { + /** + * Outcome of the transformation. + */ code?: string | null; + /** + * Number of transformations counted by this result. + */ count?: string | null; /** * A place for warnings or errors to show up if a transformation didn't work as expected. @@ -2394,7 +2567,13 @@ export namespace dlp_v2 { * Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more. */ export interface Schema$GooglePrivacyDlpV2Table { + /** + * Headers of the table. + */ headers?: Schema$GooglePrivacyDlpV2FieldId[]; + /** + * Rows of the table. + */ rows?: Schema$GooglePrivacyDlpV2Row[]; } /** @@ -2406,13 +2585,16 @@ export namespace dlp_v2 { */ rowIndex?: string | null; } + /** + * A column with a semantic tag attached. + */ export interface Schema$GooglePrivacyDlpV2TaggedField { /** * A column can be tagged with a custom tag. In this case, the user must indicate an auxiliary table that contains statistical information on the possible values of this column (below). */ customTag?: string | null; /** - * Identifies the column. [required] + * Required. Identifies the column. */ field?: Schema$GooglePrivacyDlpV2FieldId; /** @@ -2424,10 +2606,17 @@ export namespace dlp_v2 { */ infoType?: Schema$GooglePrivacyDlpV2InfoType; } + /** + * Throw an error and fail the request when a transformation error occurs. + */ + export interface Schema$GooglePrivacyDlpV2ThrowError {} /** * For use with `Date`, `Timestamp`, and `TimeOfDay`, extract or preserve a portion of the value. */ export interface Schema$GooglePrivacyDlpV2TimePartConfig { + /** + * The part of the time to keep. + */ partToExtract?: string | null; } /** @@ -2451,12 +2640,28 @@ export namespace dlp_v2 { */ timestampField?: Schema$GooglePrivacyDlpV2FieldId; } + /** + * Time zone of the date time object. + */ export interface Schema$GooglePrivacyDlpV2TimeZone { /** * Set only if the offset can be determined. Positive for time ahead of UTC. E.g. For "UTC-9", this value is -540. */ offsetMinutes?: number | null; } + /** + * How to handle transformation errors during de-identification. A transformation error occurs when the requested transformation is incompatible with the data. For example, trying to de-identify an IP address using a `DateShift` transformation would result in a transformation error, since date info cannot be extracted from an IP address. Information about any incompatible transformations, and how they were handled, is returned in the response as part of the `TransformationOverviews`. + */ + export interface Schema$GooglePrivacyDlpV2TransformationErrorHandling { + /** + * Ignore errors + */ + leaveUntransformed?: Schema$GooglePrivacyDlpV2LeaveUntransformed; + /** + * Throw an error + */ + throwError?: Schema$GooglePrivacyDlpV2ThrowError; + } /** * Overview of the modifications that occurred. */ @@ -2490,6 +2695,9 @@ export namespace dlp_v2 { * The specific suppression option these stats apply to. */ recordSuppress?: Schema$GooglePrivacyDlpV2RecordSuppression; + /** + * Collection of all transformations that took place or had an error. + */ results?: Schema$GooglePrivacyDlpV2SummaryResult[]; /** * The specific transformation these stats apply to. @@ -2505,7 +2713,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2TransientCryptoKey { /** - * Name of the key. [required] This is an arbitrary string used to differentiate different keys. A unique key is generated per name: two separate `TransientCryptoKey` protos share the same generated key if their names are the same. When the data crypto key is generated, this name is not used in any way (repeating the api call will result in a different key being generated). + * Required. Name of the key. This is an arbitrary string used to differentiate different keys. A unique key is generated per name: two separate `TransientCryptoKey` protos share the same generated key if their names are the same. When the data crypto key is generated, this name is not used in any way (repeating the api call will result in a different key being generated). */ name?: string | null; } @@ -2523,7 +2731,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2UnwrappedCryptoKey { /** - * A 128/192/256 bit key. [required] + * Required. A 128/192/256 bit key. */ key?: string | null; } @@ -2583,13 +2791,37 @@ export namespace dlp_v2 { * Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data. */ export interface Schema$GooglePrivacyDlpV2Value { + /** + * boolean + */ booleanValue?: boolean | null; + /** + * date + */ dateValue?: Schema$GoogleTypeDate; + /** + * day of week + */ dayOfWeekValue?: string | null; + /** + * float + */ floatValue?: number | null; + /** + * integer + */ integerValue?: string | null; + /** + * string + */ stringValue?: string | null; + /** + * timestamp + */ timestampValue?: string | null; + /** + * time of day + */ timeValue?: Schema$GoogleTypeTimeOfDay; } /** @@ -2687,8 +2919,8 @@ export namespace dlp_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter Optional filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT. - * @param {string=} params.languageCode Optional BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned. + * @param {string=} params.filter filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT. + * @param {string=} params.languageCode BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned. * @param {string=} params.locationId The geographic location to list info types. Reserved for future extensions. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2777,11 +3009,11 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT. + * filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT. */ filter?: string; /** - * Optional BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned. + * BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned. */ languageCode?: string; /** @@ -2812,8 +3044,8 @@ export namespace dlp_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter Optional filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT. - * @param {string=} params.languageCode Optional BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned. + * @param {string=} params.filter filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT. + * @param {string=} params.languageCode BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned. * @param {string} params.locationId The geographic location to list info types. Reserved for future extensions. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2907,11 +3139,11 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT. + * filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT. */ filter?: string; /** - * Optional BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned. + * BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned. */ languageCode?: string; /** @@ -3206,9 +3438,9 @@ export namespace dlp_v2 { * * @param {object} params Parameters for request * @param {string=} params.locationId The geographic location where deidentifications templates will be retrieved from. Use `-` for all locations. Reserved for future extensions. - * @param {string=} params.orderBy Optional comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. - * @param {integer=} params.pageSize Optional size of the page, can be limited by server. If zero server returns a page of max size 100. - * @param {string=} params.pageToken Optional page token to continue retrieval. Comes from previous call to `ListDeidentifyTemplates`. + * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. + * @param {integer=} params.pageSize Size of the page, can be limited by server. If zero server returns a page of max size 100. + * @param {string=} params.pageToken Page token to continue retrieval. Comes from previous call to `ListDeidentifyTemplates`. * @param {string} params.parent Required. The parent resource name, for example projects/my-project-id or organizations/my-org-id. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3443,15 +3675,15 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Optional comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. */ orderBy?: string; /** - * Optional size of the page, can be limited by server. If zero server returns a page of max size 100. + * Size of the page, can be limited by server. If zero server returns a page of max size 100. */ pageSize?: number; /** - * Optional page token to continue retrieval. Comes from previous call to `ListDeidentifyTemplates`. + * Page token to continue retrieval. Comes from previous call to `ListDeidentifyTemplates`. */ pageToken?: string; /** @@ -3726,9 +3958,9 @@ export namespace dlp_v2 { * * @param {object} params Parameters for request * @param {string=} params.locationId The geographic location where inspection templates will be retrieved from. Use `-` for all locations. Reserved for future extensions. - * @param {string=} params.orderBy Optional comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. - * @param {integer=} params.pageSize Optional size of the page, can be limited by server. If zero server returns a page of max size 100. - * @param {string=} params.pageToken Optional page token to continue retrieval. Comes from previous call to `ListInspectTemplates`. + * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. + * @param {integer=} params.pageSize Size of the page, can be limited by server. If zero server returns a page of max size 100. + * @param {string=} params.pageToken Page token to continue retrieval. Comes from previous call to `ListInspectTemplates`. * @param {string} params.parent Required. The parent resource name, for example projects/my-project-id or organizations/my-org-id. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3956,15 +4188,15 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Optional comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. */ orderBy?: string; /** - * Optional size of the page, can be limited by server. If zero server returns a page of max size 100. + * Size of the page, can be limited by server. If zero server returns a page of max size 100. */ pageSize?: number; /** - * Optional page token to continue retrieval. Comes from previous call to `ListInspectTemplates`. + * Page token to continue retrieval. Comes from previous call to `ListInspectTemplates`. */ pageToken?: string; /** @@ -4275,9 +4507,9 @@ export namespace dlp_v2 { * * @param {object} params Parameters for request * @param {string} params.locationId The geographic location where deidentifications templates will be retrieved from. Use `-` for all locations. Reserved for future extensions. - * @param {string=} params.orderBy Optional comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. - * @param {integer=} params.pageSize Optional size of the page, can be limited by server. If zero server returns a page of max size 100. - * @param {string=} params.pageToken Optional page token to continue retrieval. Comes from previous call to `ListDeidentifyTemplates`. + * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. + * @param {integer=} params.pageSize Size of the page, can be limited by server. If zero server returns a page of max size 100. + * @param {string=} params.pageToken Page token to continue retrieval. Comes from previous call to `ListDeidentifyTemplates`. * @param {string} params.parent Required. The parent resource name, for example projects/my-project-id or organizations/my-org-id. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4516,15 +4748,15 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Optional comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. */ orderBy?: string; /** - * Optional size of the page, can be limited by server. If zero server returns a page of max size 100. + * Size of the page, can be limited by server. If zero server returns a page of max size 100. */ pageSize?: number; /** - * Optional page token to continue retrieval. Comes from previous call to `ListDeidentifyTemplates`. + * Page token to continue retrieval. Comes from previous call to `ListDeidentifyTemplates`. */ pageToken?: string; /** @@ -4799,9 +5031,9 @@ export namespace dlp_v2 { * * @param {object} params Parameters for request * @param {string} params.locationId The geographic location where inspection templates will be retrieved from. Use `-` for all locations. Reserved for future extensions. - * @param {string=} params.orderBy Optional comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. - * @param {integer=} params.pageSize Optional size of the page, can be limited by server. If zero server returns a page of max size 100. - * @param {string=} params.pageToken Optional page token to continue retrieval. Comes from previous call to `ListInspectTemplates`. + * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. + * @param {integer=} params.pageSize Size of the page, can be limited by server. If zero server returns a page of max size 100. + * @param {string=} params.pageToken Page token to continue retrieval. Comes from previous call to `ListInspectTemplates`. * @param {string} params.parent Required. The parent resource name, for example projects/my-project-id or organizations/my-org-id. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5032,15 +5264,15 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Optional comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. */ orderBy?: string; /** - * Optional size of the page, can be limited by server. If zero server returns a page of max size 100. + * Size of the page, can be limited by server. If zero server returns a page of max size 100. */ pageSize?: number; /** - * Optional page token to continue retrieval. Comes from previous call to `ListInspectTemplates`. + * Page token to continue retrieval. Comes from previous call to `ListInspectTemplates`. */ pageToken?: string; /** @@ -5315,9 +5547,9 @@ export namespace dlp_v2 { * * @param {object} params Parameters for request * @param {string} params.locationId The geographic location where stored infoTypes will be retrieved from. Use `-` for all locations. Reserved for future extensions. - * @param {string=} params.orderBy Optional comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. - * @param {integer=} params.pageSize Optional size of the page, can be limited by server. If zero server returns a page of max size 100. - * @param {string=} params.pageToken Optional page token to continue retrieval. Comes from previous call to `ListStoredInfoTypes`. + * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. + * @param {integer=} params.pageSize Size of the page, can be limited by server. If zero server returns a page of max size 100. + * @param {string=} params.pageToken Page token to continue retrieval. Comes from previous call to `ListStoredInfoTypes`. * @param {string} params.parent Required. The parent resource name, for example projects/my-project-id or organizations/my-org-id. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5548,15 +5780,15 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Optional comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. */ orderBy?: string; /** - * Optional size of the page, can be limited by server. If zero server returns a page of max size 100. + * Size of the page, can be limited by server. If zero server returns a page of max size 100. */ pageSize?: number; /** - * Optional page token to continue retrieval. Comes from previous call to `ListStoredInfoTypes`. + * Page token to continue retrieval. Comes from previous call to `ListStoredInfoTypes`. */ pageToken?: string; /** @@ -5831,9 +6063,9 @@ export namespace dlp_v2 { * * @param {object} params Parameters for request * @param {string=} params.locationId The geographic location where stored infoTypes will be retrieved from. Use `-` for all locations. Reserved for future extensions. - * @param {string=} params.orderBy Optional comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. - * @param {integer=} params.pageSize Optional size of the page, can be limited by server. If zero server returns a page of max size 100. - * @param {string=} params.pageToken Optional page token to continue retrieval. Comes from previous call to `ListStoredInfoTypes`. + * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. + * @param {integer=} params.pageSize Size of the page, can be limited by server. If zero server returns a page of max size 100. + * @param {string=} params.pageToken Page token to continue retrieval. Comes from previous call to `ListStoredInfoTypes`. * @param {string} params.parent Required. The parent resource name, for example projects/my-project-id or organizations/my-org-id. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6061,15 +6293,15 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Optional comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. */ orderBy?: string; /** - * Optional size of the page, can be limited by server. If zero server returns a page of max size 100. + * Size of the page, can be limited by server. If zero server returns a page of max size 100. */ pageSize?: number; /** - * Optional page token to continue retrieval. Comes from previous call to `ListStoredInfoTypes`. + * Page token to continue retrieval. Comes from previous call to `ListStoredInfoTypes`. */ pageToken?: string; /** @@ -6740,9 +6972,9 @@ export namespace dlp_v2 { * * @param {object} params Parameters for request * @param {string=} params.locationId The geographic location where deidentifications templates will be retrieved from. Use `-` for all locations. Reserved for future extensions. - * @param {string=} params.orderBy Optional comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. - * @param {integer=} params.pageSize Optional size of the page, can be limited by server. If zero server returns a page of max size 100. - * @param {string=} params.pageToken Optional page token to continue retrieval. Comes from previous call to `ListDeidentifyTemplates`. + * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. + * @param {integer=} params.pageSize Size of the page, can be limited by server. If zero server returns a page of max size 100. + * @param {string=} params.pageToken Page token to continue retrieval. Comes from previous call to `ListDeidentifyTemplates`. * @param {string} params.parent Required. The parent resource name, for example projects/my-project-id or organizations/my-org-id. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6977,15 +7209,15 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Optional comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. */ orderBy?: string; /** - * Optional size of the page, can be limited by server. If zero server returns a page of max size 100. + * Size of the page, can be limited by server. If zero server returns a page of max size 100. */ pageSize?: number; /** - * Optional page token to continue retrieval. Comes from previous call to `ListDeidentifyTemplates`. + * Page token to continue retrieval. Comes from previous call to `ListDeidentifyTemplates`. */ pageToken?: string; /** @@ -7319,9 +7551,9 @@ export namespace dlp_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of ` `. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The resource name of the trigger that created job. - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * The operator must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. + * @param {string=} params.filter Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The resource name of the trigger that created job. - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * The operator must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. * @param {string=} params.locationId The geographic location where jobs will be retrieved from. Use `-` for all locations. Reserved for future extensions. - * @param {string=} params.orderBy Optional comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to time the job was created. - `end_time`: corresponds to time the job ended. - `name`: corresponds to job's name. - `state`: corresponds to `state` + * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to time the job was created. - `end_time`: corresponds to time the job ended. - `name`: corresponds to job's name. - `state`: corresponds to `state` * @param {integer=} params.pageSize The standard list page size. * @param {string=} params.pageToken The standard list page token. * @param {string} params.parent Required. The parent resource name, for example projects/my-project-id. @@ -7476,7 +7708,7 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of ` `. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The resource name of the trigger that created job. - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * The operator must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. + * Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The resource name of the trigger that created job. - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * The operator must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. */ filter?: string; /** @@ -7484,7 +7716,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Optional comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to time the job was created. - `end_time`: corresponds to time the job ended. - `name`: corresponds to job's name. - `state`: corresponds to `state` + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to time the job was created. - `end_time`: corresponds to time the job ended. - `name`: corresponds to job's name. - `state`: corresponds to `state` */ orderBy?: string; /** @@ -7871,9 +8103,9 @@ export namespace dlp_v2 { * * @param {object} params Parameters for request * @param {string=} params.locationId The geographic location where inspection templates will be retrieved from. Use `-` for all locations. Reserved for future extensions. - * @param {string=} params.orderBy Optional comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. - * @param {integer=} params.pageSize Optional size of the page, can be limited by server. If zero server returns a page of max size 100. - * @param {string=} params.pageToken Optional page token to continue retrieval. Comes from previous call to `ListInspectTemplates`. + * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. + * @param {integer=} params.pageSize Size of the page, can be limited by server. If zero server returns a page of max size 100. + * @param {string=} params.pageToken Page token to continue retrieval. Comes from previous call to `ListInspectTemplates`. * @param {string} params.parent Required. The parent resource name, for example projects/my-project-id or organizations/my-org-id. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -8101,15 +8333,15 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Optional comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. */ orderBy?: string; /** - * Optional size of the page, can be limited by server. If zero server returns a page of max size 100. + * Size of the page, can be limited by server. If zero server returns a page of max size 100. */ pageSize?: number; /** - * Optional page token to continue retrieval. Comes from previous call to `ListInspectTemplates`. + * Page token to continue retrieval. Comes from previous call to `ListInspectTemplates`. */ pageToken?: string; /** @@ -8462,11 +8694,11 @@ export namespace dlp_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of ` `. * Supported fields/values for inspect jobs: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. + * @param {string=} params.filter Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. * @param {string=} params.locationId The geographic location where job triggers will be retrieved from. Use `-` for all locations. Reserved for future extensions. - * @param {string=} params.orderBy Optional comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the JobTrigger was created. - `update_time`: corresponds to time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to JobTrigger's name. - `display_name`: corresponds to JobTrigger's display name. - `status`: corresponds to JobTrigger's status. - * @param {integer=} params.pageSize Optional size of the page, can be limited by a server. - * @param {string=} params.pageToken Optional page token to continue retrieval. Comes from previous call to ListJobTriggers. `order_by` field must not change for subsequent calls. + * @param {string=} params.orderBy Comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the JobTrigger was created. - `update_time`: corresponds to time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to JobTrigger's name. - `display_name`: corresponds to JobTrigger's display name. - `status`: corresponds to JobTrigger's status. + * @param {integer=} params.pageSize Size of the page, can be limited by a server. + * @param {string=} params.pageToken Page token to continue retrieval. Comes from previous call to ListJobTriggers. `order_by` field must not change for subsequent calls. * @param {string} params.parent Required. The parent resource name, for example `projects/my-project-id`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -8705,7 +8937,7 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of ` `. * Supported fields/values for inspect jobs: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. + * Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. */ filter?: string; /** @@ -8713,15 +8945,15 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Optional comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the JobTrigger was created. - `update_time`: corresponds to time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to JobTrigger's name. - `display_name`: corresponds to JobTrigger's display name. - `status`: corresponds to JobTrigger's status. + * Comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the JobTrigger was created. - `update_time`: corresponds to time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to JobTrigger's name. - `display_name`: corresponds to JobTrigger's display name. - `status`: corresponds to JobTrigger's status. */ orderBy?: string; /** - * Optional size of the page, can be limited by a server. + * Size of the page, can be limited by a server. */ pageSize?: number; /** - * Optional page token to continue retrieval. Comes from previous call to ListJobTriggers. `order_by` field must not change for subsequent calls. + * Page token to continue retrieval. Comes from previous call to ListJobTriggers. `order_by` field must not change for subsequent calls. */ pageToken?: string; /** @@ -9407,9 +9639,9 @@ export namespace dlp_v2 { * * @param {object} params Parameters for request * @param {string} params.locationId The geographic location where deidentifications templates will be retrieved from. Use `-` for all locations. Reserved for future extensions. - * @param {string=} params.orderBy Optional comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. - * @param {integer=} params.pageSize Optional size of the page, can be limited by server. If zero server returns a page of max size 100. - * @param {string=} params.pageToken Optional page token to continue retrieval. Comes from previous call to `ListDeidentifyTemplates`. + * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. + * @param {integer=} params.pageSize Size of the page, can be limited by server. If zero server returns a page of max size 100. + * @param {string=} params.pageToken Page token to continue retrieval. Comes from previous call to `ListDeidentifyTemplates`. * @param {string} params.parent Required. The parent resource name, for example projects/my-project-id or organizations/my-org-id. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -9648,15 +9880,15 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Optional comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. */ orderBy?: string; /** - * Optional size of the page, can be limited by server. If zero server returns a page of max size 100. + * Size of the page, can be limited by server. If zero server returns a page of max size 100. */ pageSize?: number; /** - * Optional page token to continue retrieval. Comes from previous call to `ListDeidentifyTemplates`. + * Page token to continue retrieval. Comes from previous call to `ListDeidentifyTemplates`. */ pageToken?: string; /** @@ -9990,9 +10222,9 @@ export namespace dlp_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of ` `. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The resource name of the trigger that created job. - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * The operator must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. + * @param {string=} params.filter Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The resource name of the trigger that created job. - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * The operator must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. * @param {string} params.locationId The geographic location where jobs will be retrieved from. Use `-` for all locations. Reserved for future extensions. - * @param {string=} params.orderBy Optional comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to time the job was created. - `end_time`: corresponds to time the job ended. - `name`: corresponds to job's name. - `state`: corresponds to `state` + * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to time the job was created. - `end_time`: corresponds to time the job ended. - `name`: corresponds to job's name. - `state`: corresponds to `state` * @param {integer=} params.pageSize The standard list page size. * @param {string=} params.pageToken The standard list page token. * @param {string} params.parent Required. The parent resource name, for example projects/my-project-id. @@ -10150,7 +10382,7 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of ` `. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The resource name of the trigger that created job. - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * The operator must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. + * Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The resource name of the trigger that created job. - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * The operator must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. */ filter?: string; /** @@ -10158,7 +10390,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Optional comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to time the job was created. - `end_time`: corresponds to time the job ended. - `name`: corresponds to job's name. - `state`: corresponds to `state` + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to time the job was created. - `end_time`: corresponds to time the job ended. - `name`: corresponds to job's name. - `state`: corresponds to `state` */ orderBy?: string; /** @@ -10549,9 +10781,9 @@ export namespace dlp_v2 { * * @param {object} params Parameters for request * @param {string} params.locationId The geographic location where inspection templates will be retrieved from. Use `-` for all locations. Reserved for future extensions. - * @param {string=} params.orderBy Optional comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. - * @param {integer=} params.pageSize Optional size of the page, can be limited by server. If zero server returns a page of max size 100. - * @param {string=} params.pageToken Optional page token to continue retrieval. Comes from previous call to `ListInspectTemplates`. + * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. + * @param {integer=} params.pageSize Size of the page, can be limited by server. If zero server returns a page of max size 100. + * @param {string=} params.pageToken Page token to continue retrieval. Comes from previous call to `ListInspectTemplates`. * @param {string} params.parent Required. The parent resource name, for example projects/my-project-id or organizations/my-org-id. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -10782,15 +11014,15 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Optional comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the template was created. - `update_time`: corresponds to time the template was last updated. - `name`: corresponds to template's name. - `display_name`: corresponds to template's display name. */ orderBy?: string; /** - * Optional size of the page, can be limited by server. If zero server returns a page of max size 100. + * Size of the page, can be limited by server. If zero server returns a page of max size 100. */ pageSize?: number; /** - * Optional page token to continue retrieval. Comes from previous call to `ListInspectTemplates`. + * Page token to continue retrieval. Comes from previous call to `ListInspectTemplates`. */ pageToken?: string; /** @@ -11143,11 +11375,11 @@ export namespace dlp_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of ` `. * Supported fields/values for inspect jobs: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. + * @param {string=} params.filter Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. * @param {string} params.locationId The geographic location where job triggers will be retrieved from. Use `-` for all locations. Reserved for future extensions. - * @param {string=} params.orderBy Optional comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the JobTrigger was created. - `update_time`: corresponds to time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to JobTrigger's name. - `display_name`: corresponds to JobTrigger's display name. - `status`: corresponds to JobTrigger's status. - * @param {integer=} params.pageSize Optional size of the page, can be limited by a server. - * @param {string=} params.pageToken Optional page token to continue retrieval. Comes from previous call to ListJobTriggers. `order_by` field must not change for subsequent calls. + * @param {string=} params.orderBy Comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the JobTrigger was created. - `update_time`: corresponds to time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to JobTrigger's name. - `display_name`: corresponds to JobTrigger's display name. - `status`: corresponds to JobTrigger's status. + * @param {integer=} params.pageSize Size of the page, can be limited by a server. + * @param {string=} params.pageToken Page token to continue retrieval. Comes from previous call to ListJobTriggers. `order_by` field must not change for subsequent calls. * @param {string} params.parent Required. The parent resource name, for example `projects/my-project-id`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -11389,7 +11621,7 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of ` `. * Supported fields/values for inspect jobs: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. + * Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. */ filter?: string; /** @@ -11397,15 +11629,15 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Optional comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the JobTrigger was created. - `update_time`: corresponds to time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to JobTrigger's name. - `display_name`: corresponds to JobTrigger's display name. - `status`: corresponds to JobTrigger's status. + * Comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the JobTrigger was created. - `update_time`: corresponds to time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to JobTrigger's name. - `display_name`: corresponds to JobTrigger's display name. - `status`: corresponds to JobTrigger's status. */ orderBy?: string; /** - * Optional size of the page, can be limited by a server. + * Size of the page, can be limited by a server. */ pageSize?: number; /** - * Optional page token to continue retrieval. Comes from previous call to ListJobTriggers. `order_by` field must not change for subsequent calls. + * Page token to continue retrieval. Comes from previous call to ListJobTriggers. `order_by` field must not change for subsequent calls. */ pageToken?: string; /** @@ -11680,9 +11912,9 @@ export namespace dlp_v2 { * * @param {object} params Parameters for request * @param {string} params.locationId The geographic location where stored infoTypes will be retrieved from. Use `-` for all locations. Reserved for future extensions. - * @param {string=} params.orderBy Optional comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. - * @param {integer=} params.pageSize Optional size of the page, can be limited by server. If zero server returns a page of max size 100. - * @param {string=} params.pageToken Optional page token to continue retrieval. Comes from previous call to `ListStoredInfoTypes`. + * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. + * @param {integer=} params.pageSize Size of the page, can be limited by server. If zero server returns a page of max size 100. + * @param {string=} params.pageToken Page token to continue retrieval. Comes from previous call to `ListStoredInfoTypes`. * @param {string} params.parent Required. The parent resource name, for example projects/my-project-id or organizations/my-org-id. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -11913,15 +12145,15 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Optional comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. */ orderBy?: string; /** - * Optional size of the page, can be limited by server. If zero server returns a page of max size 100. + * Size of the page, can be limited by server. If zero server returns a page of max size 100. */ pageSize?: number; /** - * Optional page token to continue retrieval. Comes from previous call to `ListStoredInfoTypes`. + * Page token to continue retrieval. Comes from previous call to `ListStoredInfoTypes`. */ pageToken?: string; /** @@ -12196,9 +12428,9 @@ export namespace dlp_v2 { * * @param {object} params Parameters for request * @param {string=} params.locationId The geographic location where stored infoTypes will be retrieved from. Use `-` for all locations. Reserved for future extensions. - * @param {string=} params.orderBy Optional comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. - * @param {integer=} params.pageSize Optional size of the page, can be limited by server. If zero server returns a page of max size 100. - * @param {string=} params.pageToken Optional page token to continue retrieval. Comes from previous call to `ListStoredInfoTypes`. + * @param {string=} params.orderBy Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. + * @param {integer=} params.pageSize Size of the page, can be limited by server. If zero server returns a page of max size 100. + * @param {string=} params.pageToken Page token to continue retrieval. Comes from previous call to `ListStoredInfoTypes`. * @param {string} params.parent Required. The parent resource name, for example projects/my-project-id or organizations/my-org-id. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -12426,15 +12658,15 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Optional comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. */ orderBy?: string; /** - * Optional size of the page, can be limited by server. If zero server returns a page of max size 100. + * Size of the page, can be limited by server. If zero server returns a page of max size 100. */ pageSize?: number; /** - * Optional page token to continue retrieval. Comes from previous call to `ListStoredInfoTypes`. + * Page token to continue retrieval. Comes from previous call to `ListStoredInfoTypes`. */ pageToken?: string; /** diff --git a/src/apis/dns/v1.ts b/src/apis/dns/v1.ts index d0c1f7ce3bf..4a98231ea39 100644 --- a/src/apis/dns/v1.ts +++ b/src/apis/dns/v1.ts @@ -310,6 +310,10 @@ export namespace dns_v1 { * Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset. */ nameServerSet?: string | null; + /** + * The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with. + */ + peeringConfig?: Schema$ManagedZonePeeringConfig; /** * For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. */ @@ -372,6 +376,30 @@ export namespace dns_v1 { */ operations?: Schema$Operation[]; } + export interface Schema$ManagedZonePeeringConfig { + /** + * Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePeeringConfig". + */ + kind?: string | null; + /** + * The network with which to peer. + */ + targetNetwork?: Schema$ManagedZonePeeringConfigTargetNetwork; + } + export interface Schema$ManagedZonePeeringConfigTargetNetwork { + /** + * The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only. + */ + deactivateTime?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePeeringConfigTargetNetwork". + */ + kind?: string | null; + /** + * The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + */ + networkUrl?: string | null; + } export interface Schema$ManagedZonePrivateVisibilityConfig { /** * Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfig". diff --git a/src/apis/dns/v2beta1.ts b/src/apis/dns/v2beta1.ts index d742c25baf2..b476b5818b1 100644 --- a/src/apis/dns/v2beta1.ts +++ b/src/apis/dns/v2beta1.ts @@ -310,6 +310,10 @@ export namespace dns_v2beta1 { * Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset. */ nameServerSet?: string | null; + /** + * The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with. + */ + peeringConfig?: Schema$ManagedZonePeeringConfig; /** * For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. */ @@ -372,6 +376,30 @@ export namespace dns_v2beta1 { */ operations?: Schema$Operation[]; } + export interface Schema$ManagedZonePeeringConfig { + /** + * Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePeeringConfig". + */ + kind?: string | null; + /** + * The network with which to peer. + */ + targetNetwork?: Schema$ManagedZonePeeringConfigTargetNetwork; + } + export interface Schema$ManagedZonePeeringConfigTargetNetwork { + /** + * The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only. + */ + deactivateTime?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePeeringConfigTargetNetwork". + */ + kind?: string | null; + /** + * The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + */ + networkUrl?: string | null; + } export interface Schema$ManagedZonePrivateVisibilityConfig { /** * Identifies what kind of resource this is. Value: the fixed string "dns#managedZonePrivateVisibilityConfig". diff --git a/src/apis/docs/v1.ts b/src/apis/docs/v1.ts index 7aacfe11a4e..a8480e91ff2 100644 --- a/src/apis/docs/v1.ts +++ b/src/apis/docs/v1.ts @@ -266,7 +266,7 @@ export namespace docs_v1 { textStyle?: Schema$TextStyle; } /** - * Creates a Footer. The new footer will be applied to the DocumentStyle. If a footer of the specified type already exists then a 400 bad request error will be returned. + * Creates a Footer. The new footer is applied to the DocumentStyle. If a footer of the specified type already exists, a 400 bad request error is returned. */ export interface Schema$CreateFooterRequest { /** @@ -284,7 +284,29 @@ export namespace docs_v1 { footerId?: string | null; } /** - * Creates a Header. The new header will be applied to the DocumentStyle. If a header of the specified type already exists then a 400 bad request error will be returned. + * Creates a Footnote segment and inserts a new FootnoteReference to it at the given location. The new Footnote segment will contain a space followed by a newline character. + */ + export interface Schema$CreateFootnoteRequest { + /** + * Inserts the footnote reference at the end of the document body. Footnote references cannot be inserted inside a header, footer or footnote. Since footnote references can only be inserted in the body, the segment ID field must be empty. + */ + endOfSegmentLocation?: Schema$EndOfSegmentLocation; + /** + * Inserts the footnote reference at a specific index in the document. The footnote reference must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). Footnote references cannot be inserted inside an equation, header, footer or footnote. Since footnote references can only be inserted in the body, the segment ID field must be empty. + */ + location?: Schema$Location; + } + /** + * The result of creating a footnote. + */ + export interface Schema$CreateFootnoteResponse { + /** + * The ID of the created footnote. + */ + footnoteId?: string | null; + } + /** + * Creates a Header. The new header is applied to the DocumentStyle. If a header of the specified type already exists, a 400 bad request error is returned. */ export interface Schema$CreateHeaderRequest { /** @@ -566,6 +588,14 @@ export namespace docs_v1 { * The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. */ marginBottom?: Schema$Dimension; + /** + * The amount of space between the bottom of the page and the contents of the footer. + */ + marginFooter?: Schema$Dimension; + /** + * The amount of space between the top of the page and the contents of the header. + */ + marginHeader?: Schema$Dimension; /** * The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. */ @@ -586,6 +616,10 @@ export namespace docs_v1 { * The size of a page in the document. */ pageSize?: Schema$Size; + /** + * Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin are used. This property is read-only. + */ + useCustomHeaderFooterMargins?: boolean | null; /** * Indicates whether to use the even page header / footer IDs for the even pages. This property is read-only. */ @@ -1113,6 +1147,23 @@ export namespace docs_v1 { */ location?: Schema$Location; } + /** + * Inserts a section break at the given location. A newline character will be inserted before the section break. + */ + export interface Schema$InsertSectionBreakRequest { + /** + * Inserts a newline and a section break at the end of the document body. Section breaks cannot be inserted inside a footnote, header or footer. Because section breaks can only be inserted inside the body, the segment ID field must be empty. + */ + endOfSegmentLocation?: Schema$EndOfSegmentLocation; + /** + * Inserts a newline and a section break at a specific index in the document. The section break must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). Section breaks cannot be inserted inside a table, equation, footnote, header, or footer. Since section breaks can only be inserted inside the body, the segment ID field must be empty. + */ + location?: Schema$Location; + /** + * The type of section to insert. + */ + sectionType?: string | null; + } /** * Inserts an empty column into a table. */ @@ -1917,6 +1968,10 @@ export namespace docs_v1 { * Creates a footer. */ createFooter?: Schema$CreateFooterRequest; + /** + * Creates a footnote. + */ + createFootnote?: Schema$CreateFootnoteRequest; /** * Creates a header. */ @@ -1961,6 +2016,10 @@ export namespace docs_v1 { * Inserts a page break at the specified location. */ insertPageBreak?: Schema$InsertPageBreakRequest; + /** + * Inserts a section break at the specified location. + */ + insertSectionBreak?: Schema$InsertSectionBreakRequest; /** * Inserts a table at the specified location. */ @@ -2005,6 +2064,10 @@ export namespace docs_v1 { * Updates the paragraph style at the specified range. */ updateParagraphStyle?: Schema$UpdateParagraphStyleRequest; + /** + * Updates the section style of the specified range. + */ + updateSectionStyle?: Schema$UpdateSectionStyleRequest; /** * Updates the style of table cells. */ @@ -2030,6 +2093,10 @@ export namespace docs_v1 { * The result of creating a footer. */ createFooter?: Schema$CreateFooterResponse; + /** + * The result of creating a footnote. + */ + createFootnote?: Schema$CreateFootnoteResponse; /** * The result of creating a header. */ @@ -2114,6 +2181,34 @@ export namespace docs_v1 { * The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. */ contentDirection?: string | null; + /** + * The bottom page margin of the section. If unset, uses margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + */ + marginBottom?: Schema$Dimension; + /** + * The footer margin of the section. If unset, uses margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + */ + marginFooter?: Schema$Dimension; + /** + * The header margin of the section. If unset, uses margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + */ + marginHeader?: Schema$Dimension; + /** + * The left page margin of the section. If unset, uses margin_left from DocumentStyle. Updating left margin causes columns in this section to resize. Since the margin affects column width, it is applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + */ + marginLeft?: Schema$Dimension; + /** + * The right page margin of the section. If unset, uses margin_right from DocumentStyle. Updating right margin causes columns in this section to resize. Since the margin affects column width, it is applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + */ + marginRight?: Schema$Dimension; + /** + * The top page margin of the section. If unset, uses margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + */ + marginTop?: Schema$Dimension; + /** + * Output only. The type of section. + */ + sectionType?: string | null; } /** * The shading of a paragraph. @@ -2847,6 +2942,23 @@ export namespace docs_v1 { */ range?: Schema$Range; } + /** + * Updates the SectionStyle. + */ + export interface Schema$UpdateSectionStyleRequest { + /** + * The fields that should be updated. At least one field must be specified. The root `section_style` is implied and must not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the left margin, set `fields` to `"margin_left"`. + */ + fields?: string | null; + /** + * The range overlapping the sections to style. Because section breaks can only be inserted inside the body, the segment ID field must be empty. + */ + range?: Schema$Range; + /** + * The styles to be set on the section. Certain section style changes may cause other changes in order to mirror the behavior of the Docs editor. See the documentation of SectionStyle for more information. + */ + sectionStyle?: Schema$SectionStyle; + } /** * Updates the style of a range of table cells. */ diff --git a/src/apis/drive/v2.ts b/src/apis/drive/v2.ts index 599dfd04d8b..38821d8ae20 100644 --- a/src/apis/drive/v2.ts +++ b/src/apis/drive/v2.ts @@ -98,7 +98,6 @@ export namespace drive_v2 { parents: Resource$Parents; permissions: Resource$Permissions; properties: Resource$Properties; - realtime: Resource$Realtime; replies: Resource$Replies; revisions: Resource$Revisions; teamdrives: Resource$Teamdrives; @@ -120,7 +119,6 @@ export namespace drive_v2 { this.parents = new Resource$Parents(this.context); this.permissions = new Resource$Permissions(this.context); this.properties = new Resource$Properties(this.context); - this.realtime = new Resource$Realtime(this.context); this.replies = new Resource$Replies(this.context); this.revisions = new Resource$Revisions(this.context); this.teamdrives = new Resource$Teamdrives(this.context); @@ -7435,209 +7433,6 @@ export namespace drive_v2 { requestBody?: Schema$Property; } - export class Resource$Realtime { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * drive.realtime.get - * @desc Exports the contents of the Realtime API data model associated with this file as JSON. - * @alias drive.realtime.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.fileId The ID of the file that the Realtime API data model is associated with. - * @param {integer=} params.revision The revision of the Realtime API data model to export. Revisions start at 1 (the initial empty data model) and are incremented with each change. If this parameter is excluded, the most recent data model will be returned. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Realtime$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Realtime$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Realtime$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Realtime$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Realtime$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Realtime$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/drive/v2/files/{fileId}/realtime').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['fileId'], - pathParams: ['fileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * drive.realtime.update - * @desc Overwrites the Realtime API data model associated with this file with the provided JSON data model. - * @alias drive.realtime.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.baseRevision The revision of the model to diff the uploaded model against. If set, the uploaded model is diffed against the provided revision and those differences are merged with any changes made to the model after the provided revision. If not set, the uploaded model replaces the current model on the server. - * @param {string} params.fileId The ID of the file that the Realtime API data model is associated with. - * @param {object} params.media Media object - * @param {string} params.media.mimeType Media mime-type - * @param {string|object} params.media.body Media body contents - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - update( - params?: Params$Resource$Realtime$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Realtime$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Realtime$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Realtime$Update - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Realtime$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Realtime$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/drive/v2/files/{fileId}/realtime').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'PUT', - }, - options - ), - params, - mediaUrl: ( - rootUrl + '/upload/drive/v2/files/{fileId}/realtime' - ).replace(/([^:]\/)\/+/g, '$1'), - requiredParams: ['fileId'], - pathParams: ['fileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Realtime$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the file that the Realtime API data model is associated with. - */ - fileId?: string; - /** - * The revision of the Realtime API data model to export. Revisions start at 1 (the initial empty data model) and are incremented with each change. If this parameter is excluded, the most recent data model will be returned. - */ - revision?: number; - } - export interface Params$Resource$Realtime$Update extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The revision of the model to diff the uploaded model against. If set, the uploaded model is diffed against the provided revision and those differences are merged with any changes made to the model after the provided revision. If not set, the uploaded model replaces the current model on the server. - */ - baseRevision?: string; - /** - * The ID of the file that the Realtime API data model is associated with. - */ - fileId?: string; - - /** - * Media metadata - */ - media?: { - /** - * Media mime-type - */ - mimeType?: string; - - /** - * Media body contents - */ - body?: any; - }; - } - export class Resource$Replies { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/driveactivity/v2.ts b/src/apis/driveactivity/v2.ts index 4183e0cac73..595a8b86668 100644 --- a/src/apis/driveactivity/v2.ts +++ b/src/apis/driveactivity/v2.ts @@ -239,6 +239,10 @@ export namespace driveactivity_v2 { * A comment with an assignment. */ export interface Schema$Assignment { + /** + * The user to whom the comment was assigned. + */ + assignedUser?: Schema$User; /** * The sub-type of this event. */ diff --git a/src/apis/file/v1.ts b/src/apis/file/v1.ts index 7615ffc083d..190df72d0be 100644 --- a/src/apis/file/v1.ts +++ b/src/apis/file/v1.ts @@ -180,6 +180,10 @@ export namespace file_v1 { rolloutMetadata?: { [key: string]: Schema$GoogleCloudSaasacceleratorManagementProvidersV1RolloutMetadata; } | null; + /** + * Link to the SLM instance template. Only populated when updating SLM instances via SSA's Actuation service adaptor. Service producers with custom control plane (e.g. Cloud SQL) doesn't need to populate this field. Instead they should use software_versions. + */ + slmInstanceTemplate?: string | null; /** * Output only. SLO metadata for instance classification in the Standardized dataplane SLO platform. See go/cloud-ssa-standard-slo for feature description. */ @@ -291,17 +295,26 @@ export namespace file_v1 { rolloutName?: string | null; } /** - * SloExclusion represents an excusion in SLI calculation applies to all SLOs. + * SloEligibility is a tuple containing eligibility value: true if an instance is eligible for SLO calculation or false if it should be excluded from all SLO-related calculations along with a user-defined reason. */ - export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion { + export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility { /** - * Exclusion duration. No restrictions on the possible values. When an ongoing operation is taking longer than initially expected, an existing entry in the exclusion list can be updated by extending the duration. This is supported by the subsystem exporting eligibility data as long as such extension is committed at least 10 minutes before the original exclusion expiration - otherwise it is possible that there will be "gaps" in the exclusion application in the exported timeseries. + * Whether an instance is eligible or ineligible. */ - exclusionDuration?: string | null; + eligible?: boolean | null; /** - * Start time of the exclusion. No alignment (e.g. to a full minute) needed. + * User-defined reason for the current value of instance eligibility. Usually, this can be directly mapped to the internal state. An empty reason is allowed. */ - exclusionStartTime?: string | null; + reason?: string | null; + } + /** + * SloExclusion represents an exclusion in SLI calculation applies to all SLOs. + */ + export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion { + /** + * Exclusion duration. No restrictions on the possible values. When an ongoing operation is taking longer than initially expected, an existing entry in the exclusion list can be updated by extending the duration. This is supported by the subsystem exporting eligibility data as long as such extension is committed at least 10 minutes before the original exclusion expiration - otherwise it is possible that there will be "gaps" in the exclusion application in the exported timeseries. + */ + duration?: string | null; /** * Human-readable reason for the exclusion. This should be a static string (e.g. "Disruptive update in progress") and should not contain dynamically generated data (e.g. instance name). Can be left empty. */ @@ -310,13 +323,21 @@ export namespace file_v1 { * Name of an SLI that this exclusion applies to. Can be left empty, signaling that the instance should be excluded from all SLIs defined in the service SLO configuration. */ sliName?: string | null; + /** + * Start time of the exclusion. No alignment (e.g. to a full minute) needed. + */ + startTime?: string | null; } /** * SloMetadata contains resources required for proper SLO classification of the instance. */ export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata { /** - * List of SLO exclusion windows. When multiple entries in the list match (matching the exclusion time-window against current time point) the exclusion reason used in the first matching entry will be published. It is not needed to include expired exclusion in this list, as only the currently applicable exclusions are taken into account by the eligibility exporting subsystem (the historical state of exclusions will be reflected in the historically produced timeseries regardless of the current state). This field can be used to mark the instance as temporary ineligible for the purpose of SLO calculation. For permanent instance SLO exclusion, a dedicated tier name can be used that does not have targets specified in the service SLO configuration. + * Optional: user-defined instance eligibility. + */ + eligibility?: Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility; + /** + * List of SLO exclusion windows. When multiple entries in the list match (matching the exclusion time-window against current time point) the exclusion reason used in the first matching entry will be published. It is not needed to include expired exclusion in this list, as only the currently applicable exclusions are taken into account by the eligibility exporting subsystem (the historical state of exclusions will be reflected in the historically produced timeseries regardless of the current state). This field can be used to mark the instance as temporary ineligible for the purpose of SLO calculation. For permanent instance SLO exclusion, use of custom instance eligibility is recommended. See 'eligibility' field below. */ exclusions?: Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion[]; /** @@ -636,6 +657,7 @@ export namespace file_v1 { * * @param {object} params Parameters for request * @param {string=} params.filter The standard list filter. + * @param {boolean=} params.includeUnrevealedLocations If true, the returned list will include locations which are not yet revealed. * @param {string} params.name The resource that owns the locations collection, if applicable. * @param {integer=} params.pageSize The standard list page size. * @param {string=} params.pageToken The standard list page token. @@ -731,6 +753,10 @@ export namespace file_v1 { * The standard list filter. */ filter?: string; + /** + * If true, the returned list will include locations which are not yet revealed. + */ + includeUnrevealedLocations?: boolean; /** * The resource that owns the locations collection, if applicable. */ @@ -1055,7 +1081,7 @@ export namespace file_v1 { * * @param {object} params Parameters for request * @param {string} params.name Output only. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}. - * @param {string=} params.updateMask Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: "description" "file_shares" "labels" + * @param {string=} params.updateMask Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: * "description" * "file_shares" * "labels" * @param {().Instance} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1206,7 +1232,7 @@ export namespace file_v1 { */ name?: string; /** - * Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: "description" "file_shares" "labels" + * Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: * "description" * "file_shares" * "labels" */ updateMask?: string; diff --git a/src/apis/file/v1beta1.ts b/src/apis/file/v1beta1.ts index 39451c19680..f677d7cf3b3 100644 --- a/src/apis/file/v1beta1.ts +++ b/src/apis/file/v1beta1.ts @@ -180,6 +180,10 @@ export namespace file_v1beta1 { rolloutMetadata?: { [key: string]: Schema$GoogleCloudSaasacceleratorManagementProvidersV1RolloutMetadata; } | null; + /** + * Link to the SLM instance template. Only populated when updating SLM instances via SSA's Actuation service adaptor. Service producers with custom control plane (e.g. Cloud SQL) doesn't need to populate this field. Instead they should use software_versions. + */ + slmInstanceTemplate?: string | null; /** * Output only. SLO metadata for instance classification in the Standardized dataplane SLO platform. See go/cloud-ssa-standard-slo for feature description. */ @@ -291,17 +295,26 @@ export namespace file_v1beta1 { rolloutName?: string | null; } /** - * SloExclusion represents an excusion in SLI calculation applies to all SLOs. + * SloEligibility is a tuple containing eligibility value: true if an instance is eligible for SLO calculation or false if it should be excluded from all SLO-related calculations along with a user-defined reason. */ - export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion { + export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility { /** - * Exclusion duration. No restrictions on the possible values. When an ongoing operation is taking longer than initially expected, an existing entry in the exclusion list can be updated by extending the duration. This is supported by the subsystem exporting eligibility data as long as such extension is committed at least 10 minutes before the original exclusion expiration - otherwise it is possible that there will be "gaps" in the exclusion application in the exported timeseries. + * Whether an instance is eligible or ineligible. */ - exclusionDuration?: string | null; + eligible?: boolean | null; /** - * Start time of the exclusion. No alignment (e.g. to a full minute) needed. + * User-defined reason for the current value of instance eligibility. Usually, this can be directly mapped to the internal state. An empty reason is allowed. */ - exclusionStartTime?: string | null; + reason?: string | null; + } + /** + * SloExclusion represents an exclusion in SLI calculation applies to all SLOs. + */ + export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion { + /** + * Exclusion duration. No restrictions on the possible values. When an ongoing operation is taking longer than initially expected, an existing entry in the exclusion list can be updated by extending the duration. This is supported by the subsystem exporting eligibility data as long as such extension is committed at least 10 minutes before the original exclusion expiration - otherwise it is possible that there will be "gaps" in the exclusion application in the exported timeseries. + */ + duration?: string | null; /** * Human-readable reason for the exclusion. This should be a static string (e.g. "Disruptive update in progress") and should not contain dynamically generated data (e.g. instance name). Can be left empty. */ @@ -310,13 +323,21 @@ export namespace file_v1beta1 { * Name of an SLI that this exclusion applies to. Can be left empty, signaling that the instance should be excluded from all SLIs defined in the service SLO configuration. */ sliName?: string | null; + /** + * Start time of the exclusion. No alignment (e.g. to a full minute) needed. + */ + startTime?: string | null; } /** * SloMetadata contains resources required for proper SLO classification of the instance. */ export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata { /** - * List of SLO exclusion windows. When multiple entries in the list match (matching the exclusion time-window against current time point) the exclusion reason used in the first matching entry will be published. It is not needed to include expired exclusion in this list, as only the currently applicable exclusions are taken into account by the eligibility exporting subsystem (the historical state of exclusions will be reflected in the historically produced timeseries regardless of the current state). This field can be used to mark the instance as temporary ineligible for the purpose of SLO calculation. For permanent instance SLO exclusion, a dedicated tier name can be used that does not have targets specified in the service SLO configuration. + * Optional: user-defined instance eligibility. + */ + eligibility?: Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility; + /** + * List of SLO exclusion windows. When multiple entries in the list match (matching the exclusion time-window against current time point) the exclusion reason used in the first matching entry will be published. It is not needed to include expired exclusion in this list, as only the currently applicable exclusions are taken into account by the eligibility exporting subsystem (the historical state of exclusions will be reflected in the historically produced timeseries regardless of the current state). This field can be used to mark the instance as temporary ineligible for the purpose of SLO calculation. For permanent instance SLO exclusion, use of custom instance eligibility is recommended. See 'eligibility' field below. */ exclusions?: Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion[]; /** @@ -636,6 +657,7 @@ export namespace file_v1beta1 { * * @param {object} params Parameters for request * @param {string=} params.filter The standard list filter. + * @param {boolean=} params.includeUnrevealedLocations If true, the returned list will include locations which are not yet revealed. * @param {string} params.name The resource that owns the locations collection, if applicable. * @param {integer=} params.pageSize The standard list page size. * @param {string=} params.pageToken The standard list page token. @@ -731,6 +753,10 @@ export namespace file_v1beta1 { * The standard list filter. */ filter?: string; + /** + * If true, the returned list will include locations which are not yet revealed. + */ + includeUnrevealedLocations?: boolean; /** * The resource that owns the locations collection, if applicable. */ @@ -1055,7 +1081,7 @@ export namespace file_v1beta1 { * * @param {object} params Parameters for request * @param {string} params.name Output only. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}. - * @param {string=} params.updateMask Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: "description" "file_shares" "labels" + * @param {string=} params.updateMask Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: * "description" * "file_shares" * "labels" * @param {().Instance} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1206,7 +1232,7 @@ export namespace file_v1beta1 { */ name?: string; /** - * Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: "description" "file_shares" "labels" + * Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: * "description" * "file_shares" * "labels" */ updateMask?: string; diff --git a/src/apis/firebase/v1beta1.ts b/src/apis/firebase/v1beta1.ts index b93af7347f7..6df329f520f 100644 --- a/src/apis/firebase/v1beta1.ts +++ b/src/apis/firebase/v1beta1.ts @@ -414,10 +414,18 @@ export namespace firebase_v1beta1 { * A GCP resource location that can be selected for a Project. */ export interface Schema$Location { + /** + * Products and services that are available in the GCP resource location. + */ + features?: string[] | null; /** * The ID of the GCP resource location. It will be one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations#types). */ locationId?: string | null; + /** + * Indicates whether the GCP resource location is a [regional or multi-regional location](https://firebase.google.com/docs/projects/locations#types) for data replication. + */ + type?: string | null; } /** * This is proto2's version of MessageSet. diff --git a/src/apis/firebaserules/v1.ts b/src/apis/firebaserules/v1.ts index fce9b454b8b..d3d41d8a164 100644 --- a/src/apis/firebaserules/v1.ts +++ b/src/apis/firebaserules/v1.ts @@ -132,6 +132,23 @@ export namespace firebaserules_v1 { * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} + /** + * Describes where in a file an expression is found and what it was evaluated to over the course of its use. + */ + export interface Schema$ExpressionReport { + /** + * Subexpressions + */ + children?: Schema$ExpressionReport[]; + /** + * Position of expression in original rules source. + */ + sourcePosition?: Schema$SourcePosition; + /** + * Values that this expression evaluated to when encountered. + */ + values?: Schema$ValueCount[]; + } /** * `File` containing source content. */ @@ -349,6 +366,10 @@ export namespace firebaserules_v1 { * Test expectation. */ expectation?: string | null; + /** + * Specifies what should be included in the response. + */ + expressionReportLevel?: string | null; /** * Optional function mocks for service-defined functions. If not set, any service defined function is expected to return an error, which may or may not influence the test outcome. */ @@ -378,6 +399,10 @@ export namespace firebaserules_v1 { * Position in the `Source` or `Ruleset` where the principle runtime error occurs. Evaluation of an expression may result in an error. Rules are deny by default, so a `DENY` expectation when an error is generated is valid. When there is a `DENY` with an error, the `SourcePosition` is returned. E.g. `error_position { line: 19 column: 37 }` */ errorPosition?: Schema$SourcePosition; + /** + * The mapping from expression in the ruleset AST to the values they were evaluated to. Partially-nested to mirror AST structure. Note that this field is actually tracking expressions and not permission statements in contrast to the "visited_expressions" field above. Literal expressions are omitted. + */ + expressionReports?: Schema$ExpressionReport[]; /** * The set of function calls made to service-defined methods. Function calls are included in the order in which they are encountered during evaluation, are provided for both mocked and unmocked functions, and included on the response regardless of the test `state`. */ @@ -439,6 +464,19 @@ export namespace firebaserules_v1 { */ updateMask?: string | null; } + /** + * Tuple for how many times an Expression was evaluated to a particular ExpressionValue. + */ + export interface Schema$ValueCount { + /** + * The amount of times that expression returned. + */ + count?: number | null; + /** + * The return value of the expression + */ + value?: any | null; + } /** * Store the position and access outcome for an expression visited in rules. */ diff --git a/src/apis/firestore/v1.ts b/src/apis/firestore/v1.ts index 79a9fda1a5e..3fecca7c8b2 100644 --- a/src/apis/firestore/v1.ts +++ b/src/apis/firestore/v1.ts @@ -219,7 +219,7 @@ export namespace firestore_v1 { */ export interface Schema$CommitResponse { /** - * The time at which the commit occurred. + * The time at which the commit occurred. Any read with an equal or greater `read_time` is guaranteed to see the effects of the commit. */ commitTime?: string | null; /** @@ -991,7 +991,7 @@ export namespace firestore_v1 { */ export interface Schema$RollbackRequest { /** - * The transaction to roll back. + * Required. The transaction to roll back. */ transaction?: string | null; } @@ -1271,7 +1271,7 @@ export namespace firestore_v1 { */ export interface Schema$WriteResponse { /** - * The time at which the commit occurred. + * The time at which the commit occurred. Any read with an equal or greater `read_time` is guaranteed to see the effects of the write. */ commitTime?: string | null; /** @@ -1335,7 +1335,7 @@ export namespace firestore_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Database to export. Should be of the form: `projects/{project_id}/databases/{database_id}`. + * @param {string} params.name Required. Database to export. Should be of the form: `projects/{project_id}/databases/{database_id}`. * @param {().GoogleFirestoreAdminV1ExportDocumentsRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1417,7 +1417,7 @@ export namespace firestore_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Database to import into. Should be of the form: `projects/{project_id}/databases/{database_id}`. + * @param {string} params.name Required. Database to import into. Should be of the form: `projects/{project_id}/databases/{database_id}`. * @param {().GoogleFirestoreAdminV1ImportDocumentsRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1501,7 +1501,7 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Database to export. Should be of the form: `projects/{project_id}/databases/{database_id}`. + * Required. Database to export. Should be of the form: `projects/{project_id}/databases/{database_id}`. */ name?: string; @@ -1518,7 +1518,7 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Database to import into. Should be of the form: `projects/{project_id}/databases/{database_id}`. + * Required. Database to import into. Should be of the form: `projects/{project_id}/databases/{database_id}`. */ name?: string; @@ -1556,7 +1556,7 @@ export namespace firestore_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}` + * @param {string} params.name Required. A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1637,7 +1637,7 @@ export namespace firestore_v1 { * @param {string=} params.filter The filter to apply to list results. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to `indexConfig.usesAncestorConfig:false`. * @param {integer=} params.pageSize The number of results to return. * @param {string=} params.pageToken A page token, returned from a previous call to FirestoreAdmin.ListFields, that may be used to get the next page of results. - * @param {string} params.parent A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` + * @param {string} params.parent Required. A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1810,7 +1810,7 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}` + * Required. A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}` */ name?: string; } @@ -1834,7 +1834,7 @@ export namespace firestore_v1 { */ pageToken?: string; /** - * A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` + * Required. A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` */ parent?: string; } @@ -1873,7 +1873,7 @@ export namespace firestore_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` + * @param {string} params.parent Required. A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` * @param {().GoogleFirestoreAdminV1Index} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1955,7 +1955,7 @@ export namespace firestore_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` + * @param {string} params.name Required. A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2024,7 +2024,7 @@ export namespace firestore_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` + * @param {string} params.name Required. A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2105,7 +2105,7 @@ export namespace firestore_v1 { * @param {string=} params.filter The filter to apply to list results. * @param {integer=} params.pageSize The number of results to return. * @param {string=} params.pageToken A page token, returned from a previous call to FirestoreAdmin.ListIndexes, that may be used to get the next page of results. - * @param {string} params.parent A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` + * @param {string} params.parent Required. A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2204,7 +2204,7 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` + * Required. A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` */ parent?: string; @@ -2221,7 +2221,7 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` + * Required. A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` */ name?: string; } @@ -2233,7 +2233,7 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` + * Required. A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` */ name?: string; } @@ -2257,7 +2257,7 @@ export namespace firestore_v1 { */ pageToken?: string; /** - * A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` + * Required. A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` */ parent?: string; } @@ -2275,7 +2275,7 @@ export namespace firestore_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.database The database name. In the format: `projects/{project_id}/databases/{database_id}`. + * @param {string} params.database Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. * @param {().BatchGetDocumentsRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2357,7 +2357,7 @@ export namespace firestore_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.database The database name. In the format: `projects/{project_id}/databases/{database_id}`. + * @param {string} params.database Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. * @param {().BeginTransactionRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2435,7 +2435,7 @@ export namespace firestore_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.database The database name. In the format: `projects/{project_id}/databases/{database_id}`. + * @param {string} params.database Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. * @param {().CommitRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2510,10 +2510,10 @@ export namespace firestore_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.collectionId The collection ID, relative to `parent`, to list. For example: `chatrooms`. + * @param {string} params.collectionId Required. The collection ID, relative to `parent`, to list. For example: `chatrooms`. * @param {string=} params.documentId The client-assigned document ID to use for this document. Optional. If not specified, an ID will be assigned by the service. * @param {string=} params.mask.fieldPaths The list of field paths in the mask. See Document.fields for a field path syntax reference. - * @param {string} params.parent The parent resource. For example: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}` + * @param {string} params.parent Required. The parent resource. For example: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}` * @param {().Document} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2588,7 +2588,7 @@ export namespace firestore_v1 { * @param {object} params Parameters for request * @param {boolean=} params.currentDocument.exists When set to `true`, the target document must exist. When set to `false`, the target document must not exist. * @param {string=} params.currentDocument.updateTime When set, the target document must exist and have been last updated at that time. - * @param {string} params.name The resource name of the Document to delete. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + * @param {string} params.name Required. The resource name of the Document to delete. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2658,7 +2658,7 @@ export namespace firestore_v1 { * * @param {object} params Parameters for request * @param {string=} params.mask.fieldPaths The list of field paths in the mask. See Document.fields for a field path syntax reference. - * @param {string} params.name The resource name of the Document to get. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + * @param {string} params.name Required. The resource name of the Document to get. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. * @param {string=} params.readTime Reads the version of the document at the given time. This may not be older than 60 seconds. * @param {string=} params.transaction Reads the document in a transaction. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2729,12 +2729,12 @@ export namespace firestore_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.collectionId The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`. + * @param {string} params.collectionId Required. The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`. * @param {string=} params.mask.fieldPaths The list of field paths in the mask. See Document.fields for a field path syntax reference. * @param {string=} params.orderBy The order to sort results by. For example: `priority desc, name`. * @param {integer=} params.pageSize The maximum number of documents to return. * @param {string=} params.pageToken The `next_page_token` value returned from a previous List request, if any. - * @param {string} params.parent The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` + * @param {string} params.parent Required. The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` * @param {string=} params.readTime Reads documents as they were at the given time. This may not be older than 60 seconds. * @param {boolean=} params.showMissing If the list should show missing documents. A missing document is a document that does not exist but has sub-documents. These documents will be returned with a key but will not have fields, Document.create_time, or Document.update_time set. Requests with `show_missing` may not specify `where` or `order_by`. * @param {string=} params.transaction Reads documents in a transaction. @@ -2813,7 +2813,7 @@ export namespace firestore_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The parent document. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` + * @param {string} params.parent Required. The parent document. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` * @param {().ListCollectionIdsRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2895,7 +2895,7 @@ export namespace firestore_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.database The database name. In the format: `projects/{project_id}/databases/{database_id}`. + * @param {string} params.database Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. * @param {().ListenRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3044,7 +3044,7 @@ export namespace firestore_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.database The database name. In the format: `projects/{project_id}/databases/{database_id}`. + * @param {string} params.database Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. * @param {().RollbackRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3117,7 +3117,7 @@ export namespace firestore_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` + * @param {string} params.parent Required. The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` * @param {().RunQueryRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3192,7 +3192,7 @@ export namespace firestore_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.database The database name. In the format: `projects/{project_id}/databases/{database_id}`. This is only required in the first message. + * @param {string} params.database Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. This is only required in the first message. * @param {().WriteRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3269,7 +3269,7 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The database name. In the format: `projects/{project_id}/databases/{database_id}`. + * Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. */ database?: string; @@ -3286,7 +3286,7 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The database name. In the format: `projects/{project_id}/databases/{database_id}`. + * Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. */ database?: string; @@ -3303,7 +3303,7 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The database name. In the format: `projects/{project_id}/databases/{database_id}`. + * Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. */ database?: string; @@ -3320,7 +3320,7 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The collection ID, relative to `parent`, to list. For example: `chatrooms`. + * Required. The collection ID, relative to `parent`, to list. For example: `chatrooms`. */ collectionId?: string; /** @@ -3332,7 +3332,7 @@ export namespace firestore_v1 { */ 'mask.fieldPaths'?: string[]; /** - * The parent resource. For example: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}` + * Required. The parent resource. For example: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}` */ parent?: string; @@ -3357,7 +3357,7 @@ export namespace firestore_v1 { */ 'currentDocument.updateTime'?: string; /** - * The resource name of the Document to delete. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + * Required. The resource name of the Document to delete. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. */ name?: string; } @@ -3373,7 +3373,7 @@ export namespace firestore_v1 { */ 'mask.fieldPaths'?: string[]; /** - * The resource name of the Document to get. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + * Required. The resource name of the Document to get. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. */ name?: string; /** @@ -3393,7 +3393,7 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`. + * Required. The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`. */ collectionId?: string; /** @@ -3413,7 +3413,7 @@ export namespace firestore_v1 { */ pageToken?: string; /** - * The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` + * Required. The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` */ parent?: string; /** @@ -3437,7 +3437,7 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The parent document. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` + * Required. The parent document. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` */ parent?: string; @@ -3454,7 +3454,7 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The database name. In the format: `projects/{project_id}/databases/{database_id}`. + * Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. */ database?: string; @@ -3504,7 +3504,7 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The database name. In the format: `projects/{project_id}/databases/{database_id}`. + * Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. */ database?: string; @@ -3521,7 +3521,7 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` + * Required. The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` */ parent?: string; @@ -3538,7 +3538,7 @@ export namespace firestore_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The database name. In the format: `projects/{project_id}/databases/{database_id}`. This is only required in the first message. + * Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. This is only required in the first message. */ database?: string; diff --git a/src/apis/firestore/v1beta1.ts b/src/apis/firestore/v1beta1.ts index 71b758d7c2f..eeb4a617edc 100644 --- a/src/apis/firestore/v1beta1.ts +++ b/src/apis/firestore/v1beta1.ts @@ -219,7 +219,7 @@ export namespace firestore_v1beta1 { */ export interface Schema$CommitResponse { /** - * The time at which the commit occurred. + * The time at which the commit occurred. Any read with an equal or greater `read_time` is guaranteed to see the effects of the commit. */ commitTime?: string | null; /** @@ -839,7 +839,7 @@ export namespace firestore_v1beta1 { */ export interface Schema$RollbackRequest { /** - * The transaction to roll back. + * Required. The transaction to roll back. */ transaction?: string | null; } @@ -1119,7 +1119,7 @@ export namespace firestore_v1beta1 { */ export interface Schema$WriteResponse { /** - * The time at which the commit occurred. + * The time at which the commit occurred. Any read with an equal or greater `read_time` is guaranteed to see the effects of the write. */ commitTime?: string | null; /** @@ -1381,7 +1381,7 @@ export namespace firestore_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.database The database name. In the format: `projects/{project_id}/databases/{database_id}`. + * @param {string} params.database Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. * @param {().BatchGetDocumentsRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1463,7 +1463,7 @@ export namespace firestore_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.database The database name. In the format: `projects/{project_id}/databases/{database_id}`. + * @param {string} params.database Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. * @param {().BeginTransactionRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1541,7 +1541,7 @@ export namespace firestore_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.database The database name. In the format: `projects/{project_id}/databases/{database_id}`. + * @param {string} params.database Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. * @param {().CommitRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1616,10 +1616,10 @@ export namespace firestore_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.collectionId The collection ID, relative to `parent`, to list. For example: `chatrooms`. + * @param {string} params.collectionId Required. The collection ID, relative to `parent`, to list. For example: `chatrooms`. * @param {string=} params.documentId The client-assigned document ID to use for this document. Optional. If not specified, an ID will be assigned by the service. * @param {string=} params.mask.fieldPaths The list of field paths in the mask. See Document.fields for a field path syntax reference. - * @param {string} params.parent The parent resource. For example: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}` + * @param {string} params.parent Required. The parent resource. For example: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}` * @param {().Document} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1694,7 +1694,7 @@ export namespace firestore_v1beta1 { * @param {object} params Parameters for request * @param {boolean=} params.currentDocument.exists When set to `true`, the target document must exist. When set to `false`, the target document must not exist. * @param {string=} params.currentDocument.updateTime When set, the target document must exist and have been last updated at that time. - * @param {string} params.name The resource name of the Document to delete. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + * @param {string} params.name Required. The resource name of the Document to delete. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1764,7 +1764,7 @@ export namespace firestore_v1beta1 { * * @param {object} params Parameters for request * @param {string=} params.mask.fieldPaths The list of field paths in the mask. See Document.fields for a field path syntax reference. - * @param {string} params.name The resource name of the Document to get. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + * @param {string} params.name Required. The resource name of the Document to get. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. * @param {string=} params.readTime Reads the version of the document at the given time. This may not be older than 60 seconds. * @param {string=} params.transaction Reads the document in a transaction. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1835,12 +1835,12 @@ export namespace firestore_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.collectionId The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`. + * @param {string} params.collectionId Required. The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`. * @param {string=} params.mask.fieldPaths The list of field paths in the mask. See Document.fields for a field path syntax reference. * @param {string=} params.orderBy The order to sort results by. For example: `priority desc, name`. * @param {integer=} params.pageSize The maximum number of documents to return. * @param {string=} params.pageToken The `next_page_token` value returned from a previous List request, if any. - * @param {string} params.parent The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` + * @param {string} params.parent Required. The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` * @param {string=} params.readTime Reads documents as they were at the given time. This may not be older than 60 seconds. * @param {boolean=} params.showMissing If the list should show missing documents. A missing document is a document that does not exist but has sub-documents. These documents will be returned with a key but will not have fields, Document.create_time, or Document.update_time set. Requests with `show_missing` may not specify `where` or `order_by`. * @param {string=} params.transaction Reads documents in a transaction. @@ -1919,7 +1919,7 @@ export namespace firestore_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The parent document. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` + * @param {string} params.parent Required. The parent document. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` * @param {().ListCollectionIdsRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2001,7 +2001,7 @@ export namespace firestore_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.database The database name. In the format: `projects/{project_id}/databases/{database_id}`. + * @param {string} params.database Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. * @param {().ListenRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2150,7 +2150,7 @@ export namespace firestore_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.database The database name. In the format: `projects/{project_id}/databases/{database_id}`. + * @param {string} params.database Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. * @param {().RollbackRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2223,7 +2223,7 @@ export namespace firestore_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` + * @param {string} params.parent Required. The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` * @param {().RunQueryRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2298,7 +2298,7 @@ export namespace firestore_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.database The database name. In the format: `projects/{project_id}/databases/{database_id}`. This is only required in the first message. + * @param {string} params.database Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. This is only required in the first message. * @param {().WriteRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2375,7 +2375,7 @@ export namespace firestore_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The database name. In the format: `projects/{project_id}/databases/{database_id}`. + * Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. */ database?: string; @@ -2392,7 +2392,7 @@ export namespace firestore_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The database name. In the format: `projects/{project_id}/databases/{database_id}`. + * Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. */ database?: string; @@ -2409,7 +2409,7 @@ export namespace firestore_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The database name. In the format: `projects/{project_id}/databases/{database_id}`. + * Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. */ database?: string; @@ -2426,7 +2426,7 @@ export namespace firestore_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The collection ID, relative to `parent`, to list. For example: `chatrooms`. + * Required. The collection ID, relative to `parent`, to list. For example: `chatrooms`. */ collectionId?: string; /** @@ -2438,7 +2438,7 @@ export namespace firestore_v1beta1 { */ 'mask.fieldPaths'?: string[]; /** - * The parent resource. For example: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}` + * Required. The parent resource. For example: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}` */ parent?: string; @@ -2463,7 +2463,7 @@ export namespace firestore_v1beta1 { */ 'currentDocument.updateTime'?: string; /** - * The resource name of the Document to delete. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + * Required. The resource name of the Document to delete. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. */ name?: string; } @@ -2479,7 +2479,7 @@ export namespace firestore_v1beta1 { */ 'mask.fieldPaths'?: string[]; /** - * The resource name of the Document to get. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + * Required. The resource name of the Document to get. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. */ name?: string; /** @@ -2499,7 +2499,7 @@ export namespace firestore_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`. + * Required. The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`. */ collectionId?: string; /** @@ -2519,7 +2519,7 @@ export namespace firestore_v1beta1 { */ pageToken?: string; /** - * The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` + * Required. The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` */ parent?: string; /** @@ -2543,7 +2543,7 @@ export namespace firestore_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The parent document. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` + * Required. The parent document. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` */ parent?: string; @@ -2560,7 +2560,7 @@ export namespace firestore_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The database name. In the format: `projects/{project_id}/databases/{database_id}`. + * Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. */ database?: string; @@ -2610,7 +2610,7 @@ export namespace firestore_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The database name. In the format: `projects/{project_id}/databases/{database_id}`. + * Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. */ database?: string; @@ -2627,7 +2627,7 @@ export namespace firestore_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` + * Required. The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` */ parent?: string; @@ -2644,7 +2644,7 @@ export namespace firestore_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The database name. In the format: `projects/{project_id}/databases/{database_id}`. This is only required in the first message. + * Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. This is only required in the first message. */ database?: string; diff --git a/src/apis/fusiontables/v1.ts b/src/apis/fusiontables/v1.ts deleted file mode 100644 index b284f19741e..00000000000 --- a/src/apis/fusiontables/v1.ts +++ /dev/null @@ -1,3569 +0,0 @@ -// Copyright 2019 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -import { - OAuth2Client, - JWT, - Compute, - UserRefreshClient, -} from 'google-auth-library'; -import { - GoogleConfigurable, - createAPIRequest, - MethodOptions, - GlobalOptions, - BodyResponseCallback, - APIRequestContext, -} from 'googleapis-common'; -import {GaxiosPromise} from 'gaxios'; - -// tslint:disable: no-any -// tslint:disable: class-name -// tslint:disable: variable-name -// tslint:disable: jsdoc-format -// tslint:disable: no-namespace - -export namespace fusiontables_v1 { - export interface Options extends GlobalOptions { - version: 'v1'; - } - - interface StandardParameters { - /** - * Data format for the response. - */ - alt?: string; - /** - * Selector specifying which fields to include in a partial response. - */ - fields?: string; - /** - * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - */ - key?: string; - /** - * OAuth 2.0 token for the current user. - */ - oauth_token?: string; - /** - * Returns response with indentations and line breaks. - */ - prettyPrint?: boolean; - /** - * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - */ - quotaUser?: string; - /** - * Deprecated. Please use quotaUser instead. - */ - userIp?: string; - } - - /** - * Fusion Tables API - * - * API for working with Fusion Tables data. - * - * @example - * const {google} = require('googleapis'); - * const fusiontables = google.fusiontables('v1'); - * - * @namespace fusiontables - * @type {Function} - * @version v1 - * @variation v1 - * @param {object=} options Options for Fusiontables - */ - export class Fusiontables { - context: APIRequestContext; - column: Resource$Column; - query: Resource$Query; - style: Resource$Style; - table: Resource$Table; - task: Resource$Task; - template: Resource$Template; - - constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = { - _options: options || {}, - google, - }; - - this.column = new Resource$Column(this.context); - this.query = new Resource$Query(this.context); - this.style = new Resource$Style(this.context); - this.table = new Resource$Table(this.context); - this.task = new Resource$Task(this.context); - this.template = new Resource$Template(this.context); - } - } - - /** - * Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting. - */ - export interface Schema$Bucket { - /** - * Color of line or the interior of a polygon in #RRGGBB format. - */ - color?: string | null; - /** - * Icon name used for a point. - */ - icon?: string | null; - /** - * Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight. - */ - max?: number | null; - /** - * Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight. - */ - min?: number | null; - /** - * Opacity of the color: 0.0 (transparent) to 1.0 (opaque). - */ - opacity?: number | null; - /** - * Width of a line (in pixels). - */ - weight?: number | null; - } - /** - * Specifies the id, name and type of a column in a table. - */ - export interface Schema$Column { - /** - * Optional identifier of the base column. If present, this column is derived from the specified base column. - */ - baseColumn?: {columnId?: number; tableIndex?: number} | null; - /** - * Identifier for the column. - */ - columnId?: number | null; - /** - * Optional column description. - */ - description?: string | null; - /** - * Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model - */ - graph_predicate?: string | null; - /** - * Type name: a template for an individual column. - */ - kind?: string | null; - /** - * Required name of the column. - */ - name?: string | null; - /** - * Required type of the column. - */ - type?: string | null; - } - /** - * Represents a list of columns in a table. - */ - export interface Schema$ColumnList { - /** - * List of all requested columns. - */ - items?: Schema$Column[]; - /** - * Type name: a list of all columns. - */ - kind?: string | null; - /** - * Token used to access the next page of this result. No token is displayed if there are no more pages left. - */ - nextPageToken?: string | null; - /** - * Total number of columns for the table. - */ - totalItems?: number | null; - } - /** - * Represents a Geometry object. - */ - export interface Schema$Geometry { - /** - * The list of geometries in this geometry collection. - */ - geometries?: any[] | null; - geometry?: any | null; - /** - * Type: A collection of geometries. - */ - type?: string | null; - } - /** - * Represents an import request. - */ - export interface Schema$Import { - /** - * Type name: a template for an import request. - */ - kind?: string | null; - /** - * The number of rows received from the import request. - */ - numRowsReceived?: string | null; - } - /** - * Represents a line geometry. - */ - export interface Schema$Line { - /** - * The coordinates that define the line. - */ - coordinates?: number[][] | null; - /** - * Type: A line geometry. - */ - type?: string | null; - } - /** - * Represents a LineStyle within a StyleSetting - */ - export interface Schema$LineStyle { - /** - * Color of the line in #RRGGBB format. - */ - strokeColor?: string | null; - /** - * Column-value, gradient or buckets styler that is used to determine the line color and opacity. - */ - strokeColorStyler?: Schema$StyleFunction; - /** - * Opacity of the line : 0.0 (transparent) to 1.0 (opaque). - */ - strokeOpacity?: number | null; - /** - * Width of the line in pixels. - */ - strokeWeight?: number | null; - /** - * Column-value or bucket styler that is used to determine the width of the line. - */ - strokeWeightStyler?: Schema$StyleFunction; - } - /** - * Represents a point object. - */ - export interface Schema$Point { - /** - * The coordinates that define the point. - */ - coordinates?: number[] | null; - /** - * Point: A point geometry. - */ - type?: string | null; - } - /** - * Represents a PointStyle within a StyleSetting - */ - export interface Schema$PointStyle { - /** - * Name of the icon. Use values defined in http://www.google.com/fusiontables/DataSource?dsrcid=308519 - */ - iconName?: string | null; - /** - * Column or a bucket value from which the icon name is to be determined. - */ - iconStyler?: Schema$StyleFunction; - } - /** - * Represents a polygon object. - */ - export interface Schema$Polygon { - /** - * The coordinates that define the polygon. - */ - coordinates?: number[][][] | null; - /** - * Type: A polygon geometry. - */ - type?: string | null; - } - /** - * Represents a PolygonStyle within a StyleSetting - */ - export interface Schema$PolygonStyle { - /** - * Color of the interior of the polygon in #RRGGBB format. - */ - fillColor?: string | null; - /** - * Column-value, gradient, or bucket styler that is used to determine the interior color and opacity of the polygon. - */ - fillColorStyler?: Schema$StyleFunction; - /** - * Opacity of the interior of the polygon: 0.0 (transparent) to 1.0 (opaque). - */ - fillOpacity?: number | null; - /** - * Color of the polygon border in #RRGGBB format. - */ - strokeColor?: string | null; - /** - * Column-value, gradient or buckets styler that is used to determine the border color and opacity. - */ - strokeColorStyler?: Schema$StyleFunction; - /** - * Opacity of the polygon border: 0.0 (transparent) to 1.0 (opaque). - */ - strokeOpacity?: number | null; - /** - * Width of the polyon border in pixels. - */ - strokeWeight?: number | null; - /** - * Column-value or bucket styler that is used to determine the width of the polygon border. - */ - strokeWeightStyler?: Schema$StyleFunction; - } - /** - * Represents a response to an sql statement. - */ - export interface Schema$Sqlresponse { - /** - * Columns in the table. - */ - columns?: string[] | null; - /** - * Type name: a template for an individual table. - */ - kind?: string | null; - /** - * The rows in the table. For each cell we print out whatever cell value (e.g., numeric, string) exists. Thus it is important that each cell contains only one value. - */ - rows?: any[][] | null; - } - /** - * Represents a StyleFunction within a StyleSetting - */ - export interface Schema$StyleFunction { - /** - * Bucket function that assigns a style based on the range a column value falls into. - */ - buckets?: Schema$Bucket[]; - /** - * Name of the column whose value is used in the style. - */ - columnName?: string | null; - /** - * Gradient function that interpolates a range of colors based on column value. - */ - gradient?: { - colors?: Array<{color?: string; opacity?: number}>; - max?: number; - min?: number; - } | null; - /** - * Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls. - */ - kind?: string | null; - } - /** - * Represents a complete StyleSettings object. The primary key is a combination of the tableId and a styleId. - */ - export interface Schema$StyleSetting { - /** - * Type name: an individual style setting. A StyleSetting contains the style defintions for points, lines, and polygons in a table. Since a table can have any one or all of them, a style definition can have point, line and polygon style definitions. - */ - kind?: string | null; - /** - * Style definition for points in the table. - */ - markerOptions?: Schema$PointStyle; - /** - * Optional name for the style setting. - */ - name?: string | null; - /** - * Style definition for polygons in the table. - */ - polygonOptions?: Schema$PolygonStyle; - /** - * Style definition for lines in the table. - */ - polylineOptions?: Schema$LineStyle; - /** - * Identifier for the style setting (unique only within tables). - */ - styleId?: number | null; - /** - * Identifier for the table. - */ - tableId?: string | null; - } - /** - * Represents a list of styles for a given table. - */ - export interface Schema$StyleSettingList { - /** - * All requested style settings. - */ - items?: Schema$StyleSetting[]; - /** - * Type name: in this case, a list of style settings. - */ - kind?: string | null; - /** - * Token used to access the next page of this result. No token is displayed if there are no more pages left. - */ - nextPageToken?: string | null; - /** - * Total number of styles for the table. - */ - totalItems?: number | null; - } - /** - * Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link. - */ - export interface Schema$Table { - /** - * Optional attribution assigned to the table. - */ - attribution?: string | null; - /** - * Optional link for attribution. - */ - attributionLink?: string | null; - /** - * Optional base table identifier if this table is a view or merged table. - */ - baseTableIds?: string[] | null; - /** - * Columns in the table. - */ - columns?: Schema$Column[]; - /** - * Optional description assigned to the table. - */ - description?: string | null; - /** - * Variable for whether table is exportable. - */ - isExportable?: boolean | null; - /** - * Type name: a template for an individual table. - */ - kind?: string | null; - /** - * Name assigned to a table. - */ - name?: string | null; - /** - * Optional sql that encodes the table definition for derived tables. - */ - sql?: string | null; - /** - * Encrypted unique alphanumeric identifier for the table. - */ - tableId?: string | null; - } - /** - * Represents a list of tables. - */ - export interface Schema$TableList { - /** - * List of all requested tables. - */ - items?: Schema$Table[]; - /** - * Type name: a list of all tables. - */ - kind?: string | null; - /** - * Token used to access the next page of this result. No token is displayed if there are no more pages left. - */ - nextPageToken?: string | null; - } - /** - * Specifies the identifier, name, and type of a task in a table. - */ - export interface Schema$Task { - /** - * Type of the resource. This is always "fusiontables#task". - */ - kind?: string | null; - /** - * An indication of task progress. - */ - progress?: string | null; - /** - * false while the table is busy with some other task. true if this background task is currently running. - */ - started?: boolean | null; - /** - * Identifier for the task. - */ - taskId?: string | null; - /** - * Type of background task. One of DELETE_ROWS Deletes one or more rows from the table. ADD_ROWS "Adds one or more rows to a table. Includes importing data into a new table and importing more rows into an existing table. ADD_COLUMN Adds a new column to the table. CHANGE_TYPE Changes the type of a column. - */ - type?: string | null; - } - /** - * Represents a list of tasks for a table. - */ - export interface Schema$TaskList { - /** - * List of all requested tasks. - */ - items?: Schema$Task[]; - /** - * Type of the resource. This is always "fusiontables#taskList". - */ - kind?: string | null; - /** - * Token used to access the next page of this result. No token is displayed if there are no more pages left. - */ - nextPageToken?: string | null; - /** - * Total number of tasks for the table. - */ - totalItems?: number | null; - } - /** - * Represents the contents of InfoWindow templates. - */ - export interface Schema$Template { - /** - * List of columns from which the template is to be automatically constructed. Only one of body or automaticColumns can be specified. - */ - automaticColumnNames?: string[] | null; - /** - * Body of the template. It contains HTML with {column_name} to insert values from a particular column. The body is sanitized to remove certain tags, e.g., script. Only one of body or automaticColumns can be specified. - */ - body?: string | null; - /** - * Type name: a template for the info window contents. The template can either include an HTML body or a list of columns from which the template is computed automatically. - */ - kind?: string | null; - /** - * Optional name assigned to a template. - */ - name?: string | null; - /** - * Identifier for the table for which the template is defined. - */ - tableId?: string | null; - /** - * Identifier for the template, unique within the context of a particular table. - */ - templateId?: number | null; - } - /** - * Represents a list of templates for a given table. - */ - export interface Schema$TemplateList { - /** - * List of all requested templates. - */ - items?: Schema$Template[]; - /** - * Type name: a list of all templates. - */ - kind?: string | null; - /** - * Token used to access the next page of this result. No token is displayed if there are no more pages left. - */ - nextPageToken?: string | null; - /** - * Total number of templates for the table. - */ - totalItems?: number | null; - } - - export class Resource$Column { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * fusiontables.column.delete - * @desc Deletes the column. - * @alias fusiontables.column.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.columnId Name or identifier for the column being deleted. - * @param {string} params.tableId Table from which the column is being deleted. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Column$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Column$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Column$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Column$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Column$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Column$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/fusiontables/v1/tables/{tableId}/columns/{columnId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['tableId', 'columnId'], - pathParams: ['columnId', 'tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.column.get - * @desc Retrieves a specific column by its id. - * @alias fusiontables.column.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.columnId Name or identifier for the column that is being requested. - * @param {string} params.tableId Table to which the column belongs. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Column$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Column$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Column$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Column$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Column$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Column$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/fusiontables/v1/tables/{tableId}/columns/{columnId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['tableId', 'columnId'], - pathParams: ['columnId', 'tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.column.insert - * @desc Adds a new column to the table. - * @alias fusiontables.column.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.tableId Table for which a new column is being added. - * @param {().Column} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - insert( - params?: Params$Resource$Column$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Column$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Column$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Column$Insert - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Column$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Column$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/fusiontables/v1/tables/{tableId}/columns' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['tableId'], - pathParams: ['tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.column.list - * @desc Retrieves a list of columns. - * @alias fusiontables.column.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.maxResults Maximum number of columns to return. Optional. Default is 5. - * @param {string=} params.pageToken Continuation token specifying which result page to return. Optional. - * @param {string} params.tableId Table whose columns are being listed. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Column$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Column$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Column$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Column$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Column$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Column$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/fusiontables/v1/tables/{tableId}/columns' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['tableId'], - pathParams: ['tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.column.patch - * @desc Updates the name or type of an existing column. This method supports patch semantics. - * @alias fusiontables.column.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.columnId Name or identifier for the column that is being updated. - * @param {string} params.tableId Table for which the column is being updated. - * @param {().Column} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - patch( - params?: Params$Resource$Column$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Column$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Column$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Column$Patch - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Column$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Column$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/fusiontables/v1/tables/{tableId}/columns/{columnId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['tableId', 'columnId'], - pathParams: ['columnId', 'tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.column.update - * @desc Updates the name or type of an existing column. - * @alias fusiontables.column.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.columnId Name or identifier for the column that is being updated. - * @param {string} params.tableId Table for which the column is being updated. - * @param {().Column} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - update( - params?: Params$Resource$Column$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Column$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Column$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Column$Update - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Column$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Column$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/fusiontables/v1/tables/{tableId}/columns/{columnId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['tableId', 'columnId'], - pathParams: ['columnId', 'tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Column$Delete extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Name or identifier for the column being deleted. - */ - columnId?: string; - /** - * Table from which the column is being deleted. - */ - tableId?: string; - } - export interface Params$Resource$Column$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Name or identifier for the column that is being requested. - */ - columnId?: string; - /** - * Table to which the column belongs. - */ - tableId?: string; - } - export interface Params$Resource$Column$Insert extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Table for which a new column is being added. - */ - tableId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Column; - } - export interface Params$Resource$Column$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Maximum number of columns to return. Optional. Default is 5. - */ - maxResults?: number; - /** - * Continuation token specifying which result page to return. Optional. - */ - pageToken?: string; - /** - * Table whose columns are being listed. - */ - tableId?: string; - } - export interface Params$Resource$Column$Patch extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Name or identifier for the column that is being updated. - */ - columnId?: string; - /** - * Table for which the column is being updated. - */ - tableId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Column; - } - export interface Params$Resource$Column$Update extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Name or identifier for the column that is being updated. - */ - columnId?: string; - /** - * Table for which the column is being updated. - */ - tableId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Column; - } - - export class Resource$Query { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * fusiontables.query.sql - * @desc Executes an SQL SELECT/INSERT/UPDATE/DELETE/SHOW/DESCRIBE/CREATE statement. - * @alias fusiontables.query.sql - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.hdrs Should column names be included (in the first row)?. Default is true. - * @param {string} params.sql An SQL SELECT/SHOW/DESCRIBE/INSERT/UPDATE/DELETE/CREATE statement. - * @param {boolean=} params.typed Should typed values be returned in the (JSON) response -- numbers for numeric values and parsed geometries for KML values? Default is true. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - sql( - params?: Params$Resource$Query$Sql, - options?: MethodOptions - ): GaxiosPromise; - sql( - params: Params$Resource$Query$Sql, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - sql( - params: Params$Resource$Query$Sql, - callback: BodyResponseCallback - ): void; - sql(callback: BodyResponseCallback): void; - sql( - paramsOrCallback?: - | Params$Resource$Query$Sql - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Query$Sql; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Query$Sql; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/fusiontables/v1/query').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['sql'], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.query.sqlGet - * @desc Executes an SQL SELECT/SHOW/DESCRIBE statement. - * @alias fusiontables.query.sqlGet - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.hdrs Should column names be included (in the first row)?. Default is true. - * @param {string} params.sql An SQL SELECT/SHOW/DESCRIBE statement. - * @param {boolean=} params.typed Should typed values be returned in the (JSON) response -- numbers for numeric values and parsed geometries for KML values? Default is true. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - sqlGet( - params?: Params$Resource$Query$Sqlget, - options?: MethodOptions - ): GaxiosPromise; - sqlGet( - params: Params$Resource$Query$Sqlget, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - sqlGet( - params: Params$Resource$Query$Sqlget, - callback: BodyResponseCallback - ): void; - sqlGet(callback: BodyResponseCallback): void; - sqlGet( - paramsOrCallback?: - | Params$Resource$Query$Sqlget - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Query$Sqlget; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Query$Sqlget; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/fusiontables/v1/query').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['sql'], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Query$Sql extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Should column names be included (in the first row)?. Default is true. - */ - hdrs?: boolean; - /** - * An SQL SELECT/SHOW/DESCRIBE/INSERT/UPDATE/DELETE/CREATE statement. - */ - sql?: string; - /** - * Should typed values be returned in the (JSON) response -- numbers for numeric values and parsed geometries for KML values? Default is true. - */ - typed?: boolean; - } - export interface Params$Resource$Query$Sqlget extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Should column names be included (in the first row)?. Default is true. - */ - hdrs?: boolean; - /** - * An SQL SELECT/SHOW/DESCRIBE statement. - */ - sql?: string; - /** - * Should typed values be returned in the (JSON) response -- numbers for numeric values and parsed geometries for KML values? Default is true. - */ - typed?: boolean; - } - - export class Resource$Style { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * fusiontables.style.delete - * @desc Deletes a style. - * @alias fusiontables.style.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer} params.styleId Identifier (within a table) for the style being deleted - * @param {string} params.tableId Table from which the style is being deleted - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Style$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Style$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Style$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Style$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Style$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Style$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/fusiontables/v1/tables/{tableId}/styles/{styleId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['tableId', 'styleId'], - pathParams: ['styleId', 'tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.style.get - * @desc Gets a specific style. - * @alias fusiontables.style.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer} params.styleId Identifier (integer) for a specific style in a table - * @param {string} params.tableId Table to which the requested style belongs - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Style$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Style$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Style$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Style$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Style$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Style$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/fusiontables/v1/tables/{tableId}/styles/{styleId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['tableId', 'styleId'], - pathParams: ['styleId', 'tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.style.insert - * @desc Adds a new style for the table. - * @alias fusiontables.style.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.tableId Table for which a new style is being added - * @param {().StyleSetting} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - insert( - params?: Params$Resource$Style$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Style$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Style$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Style$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Style$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Style$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/fusiontables/v1/tables/{tableId}/styles').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['tableId'], - pathParams: ['tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.style.list - * @desc Retrieves a list of styles. - * @alias fusiontables.style.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.maxResults Maximum number of styles to return. Optional. Default is 5. - * @param {string=} params.pageToken Continuation token specifying which result page to return. Optional. - * @param {string} params.tableId Table whose styles are being listed - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Style$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Style$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Style$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Style$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Style$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Style$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/fusiontables/v1/tables/{tableId}/styles').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['tableId'], - pathParams: ['tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.style.patch - * @desc Updates an existing style. This method supports patch semantics. - * @alias fusiontables.style.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer} params.styleId Identifier (within a table) for the style being updated. - * @param {string} params.tableId Table whose style is being updated. - * @param {().StyleSetting} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - patch( - params?: Params$Resource$Style$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Style$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Style$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Style$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Style$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Style$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/fusiontables/v1/tables/{tableId}/styles/{styleId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['tableId', 'styleId'], - pathParams: ['styleId', 'tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.style.update - * @desc Updates an existing style. - * @alias fusiontables.style.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer} params.styleId Identifier (within a table) for the style being updated. - * @param {string} params.tableId Table whose style is being updated. - * @param {().StyleSetting} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - update( - params?: Params$Resource$Style$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Style$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Style$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Style$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Style$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Style$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/fusiontables/v1/tables/{tableId}/styles/{styleId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['tableId', 'styleId'], - pathParams: ['styleId', 'tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Style$Delete extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Identifier (within a table) for the style being deleted - */ - styleId?: number; - /** - * Table from which the style is being deleted - */ - tableId?: string; - } - export interface Params$Resource$Style$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Identifier (integer) for a specific style in a table - */ - styleId?: number; - /** - * Table to which the requested style belongs - */ - tableId?: string; - } - export interface Params$Resource$Style$Insert extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Table for which a new style is being added - */ - tableId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$StyleSetting; - } - export interface Params$Resource$Style$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Maximum number of styles to return. Optional. Default is 5. - */ - maxResults?: number; - /** - * Continuation token specifying which result page to return. Optional. - */ - pageToken?: string; - /** - * Table whose styles are being listed - */ - tableId?: string; - } - export interface Params$Resource$Style$Patch extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Identifier (within a table) for the style being updated. - */ - styleId?: number; - /** - * Table whose style is being updated. - */ - tableId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$StyleSetting; - } - export interface Params$Resource$Style$Update extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Identifier (within a table) for the style being updated. - */ - styleId?: number; - /** - * Table whose style is being updated. - */ - tableId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$StyleSetting; - } - - export class Resource$Table { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * fusiontables.table.copy - * @desc Copies a table. - * @alias fusiontables.table.copy - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.copyPresentation Whether to also copy tabs, styles, and templates. Default is false. - * @param {string} params.tableId ID of the table that is being copied. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - copy( - params?: Params$Resource$Table$Copy, - options?: MethodOptions - ): GaxiosPromise; - copy( - params: Params$Resource$Table$Copy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - copy( - params: Params$Resource$Table$Copy, - callback: BodyResponseCallback - ): void; - copy(callback: BodyResponseCallback): void; - copy( - paramsOrCallback?: - | Params$Resource$Table$Copy - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Table$Copy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Table$Copy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/fusiontables/v1/tables/{tableId}/copy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['tableId'], - pathParams: ['tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.table.delete - * @desc Deletes a table. - * @alias fusiontables.table.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.tableId ID of the table that is being deleted. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Table$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Table$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Table$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Table$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Table$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Table$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/fusiontables/v1/tables/{tableId}').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['tableId'], - pathParams: ['tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.table.get - * @desc Retrieves a specific table by its id. - * @alias fusiontables.table.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.tableId Identifier(ID) for the table being requested. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Table$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Table$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Table$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Table$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Table$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Table$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/fusiontables/v1/tables/{tableId}').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['tableId'], - pathParams: ['tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.table.importRows - * @desc Import more rows into a table. - * @alias fusiontables.table.importRows - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.delimiter The delimiter used to separate cell values. This can only consist of a single character. Default is ','. - * @param {string=} params.encoding The encoding of the content. Default is UTF-8. Use 'auto-detect' if you are unsure of the encoding. - * @param {integer=} params.endLine The index of the last line from which to start importing, exclusive. Thus, the number of imported lines is endLine - startLine. If this parameter is not provided, the file will be imported until the last line of the file. If endLine is negative, then the imported content will exclude the last endLine lines. That is, if endline is negative, no line will be imported whose index is greater than N + endLine where N is the number of lines in the file, and the number of imported lines will be N + endLine - startLine. - * @param {boolean=} params.isStrict Whether the CSV must have the same number of values for each row. If false, rows with fewer values will be padded with empty values. Default is true. - * @param {integer=} params.startLine The index of the first line from which to start importing, inclusive. Default is 0. - * @param {string} params.tableId The table into which new rows are being imported. - * @param {object} params.media Media object - * @param {string} params.media.mimeType Media mime-type - * @param {string|object} params.media.body Media body contents - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - importRows( - params?: Params$Resource$Table$Importrows, - options?: MethodOptions - ): GaxiosPromise; - importRows( - params: Params$Resource$Table$Importrows, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - importRows( - params: Params$Resource$Table$Importrows, - callback: BodyResponseCallback - ): void; - importRows(callback: BodyResponseCallback): void; - importRows( - paramsOrCallback?: - | Params$Resource$Table$Importrows - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Table$Importrows; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Table$Importrows; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/fusiontables/v1/tables/{tableId}/import').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - mediaUrl: ( - rootUrl + '/upload/fusiontables/v1/tables/{tableId}/import' - ).replace(/([^:]\/)\/+/g, '$1'), - requiredParams: ['tableId'], - pathParams: ['tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.table.importTable - * @desc Import a new table. - * @alias fusiontables.table.importTable - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.delimiter The delimiter used to separate cell values. This can only consist of a single character. Default is ','. - * @param {string=} params.encoding The encoding of the content. Default is UTF-8. Use 'auto-detect' if you are unsure of the encoding. - * @param {string} params.name The name to be assigned to the new table. - * @param {object} params.media Media object - * @param {string} params.media.mimeType Media mime-type - * @param {string|object} params.media.body Media body contents - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - importTable( - params?: Params$Resource$Table$Importtable, - options?: MethodOptions - ): GaxiosPromise; - importTable( - params: Params$Resource$Table$Importtable, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - importTable( - params: Params$Resource$Table$Importtable, - callback: BodyResponseCallback - ): void; - importTable(callback: BodyResponseCallback): void; - importTable( - paramsOrCallback?: - | Params$Resource$Table$Importtable - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Table$Importtable; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Table$Importtable; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/fusiontables/v1/tables/import').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - mediaUrl: (rootUrl + '/upload/fusiontables/v1/tables/import').replace( - /([^:]\/)\/+/g, - '$1' - ), - requiredParams: ['name'], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.table.insert - * @desc Creates a new table. - * @alias fusiontables.table.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {().Table} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - insert( - params?: Params$Resource$Table$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Table$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Table$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Table$Insert - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Table$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Table$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/fusiontables/v1/tables').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.table.list - * @desc Retrieves a list of tables a user owns. - * @alias fusiontables.table.list - * @memberOf! () - * - * @param {object=} params Parameters for request - * @param {integer=} params.maxResults Maximum number of styles to return. Optional. Default is 5. - * @param {string=} params.pageToken Continuation token specifying which result page to return. Optional. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Table$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Table$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Table$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Table$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Table$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Table$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/fusiontables/v1/tables').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.table.patch - * @desc Updates an existing table. Unless explicitly requested, only the name, description, and attribution will be updated. This method supports patch semantics. - * @alias fusiontables.table.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.replaceViewDefinition Should the view definition also be updated? The specified view definition replaces the existing one. Only a view can be updated with a new definition. - * @param {string} params.tableId ID of the table that is being updated. - * @param {().Table} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - patch( - params?: Params$Resource$Table$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Table$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Table$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Table$Patch - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Table$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Table$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/fusiontables/v1/tables/{tableId}').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['tableId'], - pathParams: ['tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.table.update - * @desc Updates an existing table. Unless explicitly requested, only the name, description, and attribution will be updated. - * @alias fusiontables.table.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.replaceViewDefinition Should the view definition also be updated? The specified view definition replaces the existing one. Only a view can be updated with a new definition. - * @param {string} params.tableId ID of the table that is being updated. - * @param {().Table} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - update( - params?: Params$Resource$Table$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Table$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Table$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Table$Update - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Table$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Table$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/fusiontables/v1/tables/{tableId}').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['tableId'], - pathParams: ['tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Table$Copy extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Whether to also copy tabs, styles, and templates. Default is false. - */ - copyPresentation?: boolean; - /** - * ID of the table that is being copied. - */ - tableId?: string; - } - export interface Params$Resource$Table$Delete extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * ID of the table that is being deleted. - */ - tableId?: string; - } - export interface Params$Resource$Table$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Identifier(ID) for the table being requested. - */ - tableId?: string; - } - export interface Params$Resource$Table$Importrows extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The delimiter used to separate cell values. This can only consist of a single character. Default is ','. - */ - delimiter?: string; - /** - * The encoding of the content. Default is UTF-8. Use 'auto-detect' if you are unsure of the encoding. - */ - encoding?: string; - /** - * The index of the last line from which to start importing, exclusive. Thus, the number of imported lines is endLine - startLine. If this parameter is not provided, the file will be imported until the last line of the file. If endLine is negative, then the imported content will exclude the last endLine lines. That is, if endline is negative, no line will be imported whose index is greater than N + endLine where N is the number of lines in the file, and the number of imported lines will be N + endLine - startLine. - */ - endLine?: number; - /** - * Whether the CSV must have the same number of values for each row. If false, rows with fewer values will be padded with empty values. Default is true. - */ - isStrict?: boolean; - /** - * The index of the first line from which to start importing, inclusive. Default is 0. - */ - startLine?: number; - /** - * The table into which new rows are being imported. - */ - tableId?: string; - - /** - * Media metadata - */ - media?: { - /** - * Media mime-type - */ - mimeType?: string; - - /** - * Media body contents - */ - body?: any; - }; - } - export interface Params$Resource$Table$Importtable - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The delimiter used to separate cell values. This can only consist of a single character. Default is ','. - */ - delimiter?: string; - /** - * The encoding of the content. Default is UTF-8. Use 'auto-detect' if you are unsure of the encoding. - */ - encoding?: string; - /** - * The name to be assigned to the new table. - */ - name?: string; - - /** - * Media metadata - */ - media?: { - /** - * Media mime-type - */ - mimeType?: string; - - /** - * Media body contents - */ - body?: any; - }; - } - export interface Params$Resource$Table$Insert extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Request body metadata - */ - requestBody?: Schema$Table; - } - export interface Params$Resource$Table$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Maximum number of styles to return. Optional. Default is 5. - */ - maxResults?: number; - /** - * Continuation token specifying which result page to return. Optional. - */ - pageToken?: string; - } - export interface Params$Resource$Table$Patch extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Should the view definition also be updated? The specified view definition replaces the existing one. Only a view can be updated with a new definition. - */ - replaceViewDefinition?: boolean; - /** - * ID of the table that is being updated. - */ - tableId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Table; - } - export interface Params$Resource$Table$Update extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Should the view definition also be updated? The specified view definition replaces the existing one. Only a view can be updated with a new definition. - */ - replaceViewDefinition?: boolean; - /** - * ID of the table that is being updated. - */ - tableId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Table; - } - - export class Resource$Task { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * fusiontables.task.delete - * @desc Deletes the task, unless already started. - * @alias fusiontables.task.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.tableId Table from which the task is being deleted. - * @param {string} params.taskId - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Task$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Task$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Task$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Task$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Task$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Task$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/fusiontables/v1/tables/{tableId}/tasks/{taskId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['tableId', 'taskId'], - pathParams: ['tableId', 'taskId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.task.get - * @desc Retrieves a specific task by its id. - * @alias fusiontables.task.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.tableId Table to which the task belongs. - * @param {string} params.taskId - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Task$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Task$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Task$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Task$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Task$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Task$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/fusiontables/v1/tables/{tableId}/tasks/{taskId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['tableId', 'taskId'], - pathParams: ['tableId', 'taskId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.task.list - * @desc Retrieves a list of tasks. - * @alias fusiontables.task.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.maxResults Maximum number of columns to return. Optional. Default is 5. - * @param {string=} params.pageToken - * @param {integer=} params.startIndex - * @param {string} params.tableId Table whose tasks are being listed. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Task$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Task$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Task$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Task$List - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Task$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Task$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/fusiontables/v1/tables/{tableId}/tasks').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['tableId'], - pathParams: ['tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Task$Delete extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Table from which the task is being deleted. - */ - tableId?: string; - /** - * - */ - taskId?: string; - } - export interface Params$Resource$Task$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Table to which the task belongs. - */ - tableId?: string; - /** - * - */ - taskId?: string; - } - export interface Params$Resource$Task$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Maximum number of columns to return. Optional. Default is 5. - */ - maxResults?: number; - /** - * - */ - pageToken?: string; - /** - * - */ - startIndex?: number; - /** - * Table whose tasks are being listed. - */ - tableId?: string; - } - - export class Resource$Template { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * fusiontables.template.delete - * @desc Deletes a template - * @alias fusiontables.template.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.tableId Table from which the template is being deleted - * @param {integer} params.templateId Identifier for the template which is being deleted - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Template$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Template$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Template$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Template$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Template$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Template$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/fusiontables/v1/tables/{tableId}/templates/{templateId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['tableId', 'templateId'], - pathParams: ['tableId', 'templateId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.template.get - * @desc Retrieves a specific template by its id - * @alias fusiontables.template.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.tableId Table to which the template belongs - * @param {integer} params.templateId Identifier for the template that is being requested - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Template$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Template$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Template$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Template$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Template$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Template$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/fusiontables/v1/tables/{tableId}/templates/{templateId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['tableId', 'templateId'], - pathParams: ['tableId', 'templateId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.template.insert - * @desc Creates a new template for the table. - * @alias fusiontables.template.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.tableId Table for which a new template is being created - * @param {().Template} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - insert( - params?: Params$Resource$Template$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Template$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Template$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Template$Insert - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Template$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Template$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/fusiontables/v1/tables/{tableId}/templates' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['tableId'], - pathParams: ['tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.template.list - * @desc Retrieves a list of templates. - * @alias fusiontables.template.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.maxResults Maximum number of templates to return. Optional. Default is 5. - * @param {string=} params.pageToken Continuation token specifying which results page to return. Optional. - * @param {string} params.tableId Identifier for the table whose templates are being requested - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Template$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Template$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Template$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Template$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Template$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Template$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/fusiontables/v1/tables/{tableId}/templates' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['tableId'], - pathParams: ['tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.template.patch - * @desc Updates an existing template. This method supports patch semantics. - * @alias fusiontables.template.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.tableId Table to which the updated template belongs - * @param {integer} params.templateId Identifier for the template that is being updated - * @param {().Template} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - patch( - params?: Params$Resource$Template$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Template$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Template$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Template$Patch - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Template$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Template$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/fusiontables/v1/tables/{tableId}/templates/{templateId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['tableId', 'templateId'], - pathParams: ['tableId', 'templateId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.template.update - * @desc Updates an existing template - * @alias fusiontables.template.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.tableId Table to which the updated template belongs - * @param {integer} params.templateId Identifier for the template that is being updated - * @param {().Template} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - update( - params?: Params$Resource$Template$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Template$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Template$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Template$Update - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Template$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Template$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/fusiontables/v1/tables/{tableId}/templates/{templateId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['tableId', 'templateId'], - pathParams: ['tableId', 'templateId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Template$Delete extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Table from which the template is being deleted - */ - tableId?: string; - /** - * Identifier for the template which is being deleted - */ - templateId?: number; - } - export interface Params$Resource$Template$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Table to which the template belongs - */ - tableId?: string; - /** - * Identifier for the template that is being requested - */ - templateId?: number; - } - export interface Params$Resource$Template$Insert extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Table for which a new template is being created - */ - tableId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Template; - } - export interface Params$Resource$Template$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Maximum number of templates to return. Optional. Default is 5. - */ - maxResults?: number; - /** - * Continuation token specifying which results page to return. Optional. - */ - pageToken?: string; - /** - * Identifier for the table whose templates are being requested - */ - tableId?: string; - } - export interface Params$Resource$Template$Patch extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Table to which the updated template belongs - */ - tableId?: string; - /** - * Identifier for the template that is being updated - */ - templateId?: number; - - /** - * Request body metadata - */ - requestBody?: Schema$Template; - } - export interface Params$Resource$Template$Update extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Table to which the updated template belongs - */ - tableId?: string; - /** - * Identifier for the template that is being updated - */ - templateId?: number; - - /** - * Request body metadata - */ - requestBody?: Schema$Template; - } -} diff --git a/src/apis/fusiontables/v2.ts b/src/apis/fusiontables/v2.ts deleted file mode 100644 index ab8b6860e0b..00000000000 --- a/src/apis/fusiontables/v2.ts +++ /dev/null @@ -1,3813 +0,0 @@ -// Copyright 2019 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -import { - OAuth2Client, - JWT, - Compute, - UserRefreshClient, -} from 'google-auth-library'; -import { - GoogleConfigurable, - createAPIRequest, - MethodOptions, - GlobalOptions, - BodyResponseCallback, - APIRequestContext, -} from 'googleapis-common'; -import {GaxiosPromise} from 'gaxios'; - -// tslint:disable: no-any -// tslint:disable: class-name -// tslint:disable: variable-name -// tslint:disable: jsdoc-format -// tslint:disable: no-namespace - -export namespace fusiontables_v2 { - export interface Options extends GlobalOptions { - version: 'v2'; - } - - interface StandardParameters { - /** - * Data format for the response. - */ - alt?: string; - /** - * Selector specifying which fields to include in a partial response. - */ - fields?: string; - /** - * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - */ - key?: string; - /** - * OAuth 2.0 token for the current user. - */ - oauth_token?: string; - /** - * Returns response with indentations and line breaks. - */ - prettyPrint?: boolean; - /** - * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - */ - quotaUser?: string; - /** - * Deprecated. Please use quotaUser instead. - */ - userIp?: string; - } - - /** - * Fusion Tables API - * - * API for working with Fusion Tables data. - * - * @example - * const {google} = require('googleapis'); - * const fusiontables = google.fusiontables('v2'); - * - * @namespace fusiontables - * @type {Function} - * @version v2 - * @variation v2 - * @param {object=} options Options for Fusiontables - */ - export class Fusiontables { - context: APIRequestContext; - column: Resource$Column; - query: Resource$Query; - style: Resource$Style; - table: Resource$Table; - task: Resource$Task; - template: Resource$Template; - - constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = { - _options: options || {}, - google, - }; - - this.column = new Resource$Column(this.context); - this.query = new Resource$Query(this.context); - this.style = new Resource$Style(this.context); - this.table = new Resource$Table(this.context); - this.task = new Resource$Task(this.context); - this.template = new Resource$Template(this.context); - } - } - - /** - * Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting. - */ - export interface Schema$Bucket { - /** - * Color of line or the interior of a polygon in #RRGGBB format. - */ - color?: string | null; - /** - * Icon name used for a point. - */ - icon?: string | null; - /** - * Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight. - */ - max?: number | null; - /** - * Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight. - */ - min?: number | null; - /** - * Opacity of the color: 0.0 (transparent) to 1.0 (opaque). - */ - opacity?: number | null; - /** - * Width of a line (in pixels). - */ - weight?: number | null; - } - /** - * Specifies the details of a column in a table. - */ - export interface Schema$Column { - /** - * Identifier of the base column. If present, this column is derived from the specified base column. - */ - baseColumn?: {columnId?: number; tableIndex?: number} | null; - /** - * Identifier for the column. - */ - columnId?: number | null; - /** - * JSON schema for interpreting JSON in this column. - */ - columnJsonSchema?: string | null; - /** - * JSON object containing custom column properties. - */ - columnPropertiesJson?: string | null; - /** - * Column description. - */ - description?: string | null; - /** - * Format pattern. Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows editing of text as JSON in UI STRING_JSON_LISTAllows editing of text as a JSON list in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail - */ - formatPattern?: string | null; - /** - * Column graph predicate. Used to map table to graph data model (subject,predicate,object) See W3C Graph-based Data Model. - */ - graphPredicate?: string | null; - /** - * The kind of item this is. For a column, this is always fusiontables#column. - */ - kind?: string | null; - /** - * Name of the column. - */ - name?: string | null; - /** - * Type of the column. - */ - type?: string | null; - /** - * If true, data entered via the web application is validated. - */ - validateData?: boolean | null; - /** - * List of valid values used to validate data and supply a drop-down list of values in the web application. - */ - validValues?: string[] | null; - } - /** - * Represents a list of columns in a table. - */ - export interface Schema$ColumnList { - /** - * List of all requested columns. - */ - items?: Schema$Column[]; - /** - * The kind of item this is. For a column list, this is always fusiontables#columnList. - */ - kind?: string | null; - /** - * Token used to access the next page of this result. No token is displayed if there are no more pages left. - */ - nextPageToken?: string | null; - /** - * Total number of columns for the table. - */ - totalItems?: number | null; - } - /** - * Represents a Geometry object. - */ - export interface Schema$Geometry { - /** - * The list of geometries in this geometry collection. - */ - geometries?: any[] | null; - geometry?: any | null; - /** - * Type: A collection of geometries. - */ - type?: string | null; - } - /** - * Represents an import request. - */ - export interface Schema$Import { - /** - * The kind of item this is. For an import, this is always fusiontables#import. - */ - kind?: string | null; - /** - * The number of rows received from the import request. - */ - numRowsReceived?: string | null; - } - /** - * Represents a line geometry. - */ - export interface Schema$Line { - /** - * The coordinates that define the line. - */ - coordinates?: number[][] | null; - /** - * Type: A line geometry. - */ - type?: string | null; - } - /** - * Represents a LineStyle within a StyleSetting - */ - export interface Schema$LineStyle { - /** - * Color of the line in #RRGGBB format. - */ - strokeColor?: string | null; - /** - * Column-value, gradient or buckets styler that is used to determine the line color and opacity. - */ - strokeColorStyler?: Schema$StyleFunction; - /** - * Opacity of the line : 0.0 (transparent) to 1.0 (opaque). - */ - strokeOpacity?: number | null; - /** - * Width of the line in pixels. - */ - strokeWeight?: number | null; - /** - * Column-value or bucket styler that is used to determine the width of the line. - */ - strokeWeightStyler?: Schema$StyleFunction; - } - /** - * Represents a point object. - */ - export interface Schema$Point { - /** - * The coordinates that define the point. - */ - coordinates?: number[] | null; - /** - * Point: A point geometry. - */ - type?: string | null; - } - /** - * Represents a PointStyle within a StyleSetting - */ - export interface Schema$PointStyle { - /** - * Name of the icon. Use values defined in http://www.google.com/fusiontables/DataSource?dsrcid=308519 - */ - iconName?: string | null; - /** - * Column or a bucket value from which the icon name is to be determined. - */ - iconStyler?: Schema$StyleFunction; - } - /** - * Represents a polygon object. - */ - export interface Schema$Polygon { - /** - * The coordinates that define the polygon. - */ - coordinates?: number[][][] | null; - /** - * Type: A polygon geometry. - */ - type?: string | null; - } - /** - * Represents a PolygonStyle within a StyleSetting - */ - export interface Schema$PolygonStyle { - /** - * Color of the interior of the polygon in #RRGGBB format. - */ - fillColor?: string | null; - /** - * Column-value, gradient, or bucket styler that is used to determine the interior color and opacity of the polygon. - */ - fillColorStyler?: Schema$StyleFunction; - /** - * Opacity of the interior of the polygon: 0.0 (transparent) to 1.0 (opaque). - */ - fillOpacity?: number | null; - /** - * Color of the polygon border in #RRGGBB format. - */ - strokeColor?: string | null; - /** - * Column-value, gradient or buckets styler that is used to determine the border color and opacity. - */ - strokeColorStyler?: Schema$StyleFunction; - /** - * Opacity of the polygon border: 0.0 (transparent) to 1.0 (opaque). - */ - strokeOpacity?: number | null; - /** - * Width of the polyon border in pixels. - */ - strokeWeight?: number | null; - /** - * Column-value or bucket styler that is used to determine the width of the polygon border. - */ - strokeWeightStyler?: Schema$StyleFunction; - } - /** - * Represents a response to a SQL statement. - */ - export interface Schema$Sqlresponse { - /** - * Columns in the table. - */ - columns?: string[] | null; - /** - * The kind of item this is. For responses to SQL queries, this is always fusiontables#sqlresponse. - */ - kind?: string | null; - /** - * The rows in the table. For each cell we print out whatever cell value (e.g., numeric, string) exists. Thus it is important that each cell contains only one value. - */ - rows?: any[][] | null; - } - /** - * Represents a StyleFunction within a StyleSetting - */ - export interface Schema$StyleFunction { - /** - * Bucket function that assigns a style based on the range a column value falls into. - */ - buckets?: Schema$Bucket[]; - /** - * Name of the column whose value is used in the style. - */ - columnName?: string | null; - /** - * Gradient function that interpolates a range of colors based on column value. - */ - gradient?: { - colors?: Array<{color?: string; opacity?: number}>; - max?: number; - min?: number; - } | null; - /** - * Stylers can be one of three kinds: "fusiontables#fromColumn if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; fusiontables#gradient if the styling of the row is to be based on applying the gradient function on the column value; or fusiontables#buckets if the styling is to based on the bucket into which the the column value falls. - */ - kind?: string | null; - } - /** - * Represents a complete StyleSettings object. The primary key is a combination of the tableId and a styleId. - */ - export interface Schema$StyleSetting { - /** - * The kind of item this is. A StyleSetting contains the style definitions for points, lines, and polygons in a table. Since a table can have any one or all of them, a style definition can have point, line and polygon style definitions. - */ - kind?: string | null; - /** - * Style definition for points in the table. - */ - markerOptions?: Schema$PointStyle; - /** - * Optional name for the style setting. - */ - name?: string | null; - /** - * Style definition for polygons in the table. - */ - polygonOptions?: Schema$PolygonStyle; - /** - * Style definition for lines in the table. - */ - polylineOptions?: Schema$LineStyle; - /** - * Identifier for the style setting (unique only within tables). - */ - styleId?: number | null; - /** - * Identifier for the table. - */ - tableId?: string | null; - } - /** - * Represents a list of styles for a given table. - */ - export interface Schema$StyleSettingList { - /** - * All requested style settings. - */ - items?: Schema$StyleSetting[]; - /** - * The kind of item this is. For a style list, this is always fusiontables#styleSettingList . - */ - kind?: string | null; - /** - * Token used to access the next page of this result. No token is displayed if there are no more styles left. - */ - nextPageToken?: string | null; - /** - * Total number of styles for the table. - */ - totalItems?: number | null; - } - /** - * Represents a table. - */ - export interface Schema$Table { - /** - * Attribution assigned to the table. - */ - attribution?: string | null; - /** - * Optional link for attribution. - */ - attributionLink?: string | null; - /** - * Base table identifier if this table is a view or merged table. - */ - baseTableIds?: string[] | null; - /** - * Default JSON schema for validating all JSON column properties. - */ - columnPropertiesJsonSchema?: string | null; - /** - * Columns in the table. - */ - columns?: Schema$Column[]; - /** - * Description assigned to the table. - */ - description?: string | null; - /** - * Variable for whether table is exportable. - */ - isExportable?: boolean | null; - /** - * The kind of item this is. For a table, this is always fusiontables#table. - */ - kind?: string | null; - /** - * Name assigned to a table. - */ - name?: string | null; - /** - * SQL that encodes the table definition for derived tables. - */ - sql?: string | null; - /** - * Encrypted unique alphanumeric identifier for the table. - */ - tableId?: string | null; - /** - * JSON object containing custom table properties. - */ - tablePropertiesJson?: string | null; - /** - * JSON schema for validating the JSON table properties. - */ - tablePropertiesJsonSchema?: string | null; - } - /** - * Represents a list of tables. - */ - export interface Schema$TableList { - /** - * List of all requested tables. - */ - items?: Schema$Table[]; - /** - * The kind of item this is. For table list, this is always fusiontables#tableList. - */ - kind?: string | null; - /** - * Token used to access the next page of this result. No token is displayed if there are no more pages left. - */ - nextPageToken?: string | null; - } - /** - * A background task on a table, initiated for time- or resource-consuming operations such as changing column types or deleting all rows. - */ - export interface Schema$Task { - /** - * Type of the resource. This is always "fusiontables#task". - */ - kind?: string | null; - /** - * Task percentage completion. - */ - progress?: string | null; - /** - * false while the table is busy with some other task. true if this background task is currently running. - */ - started?: boolean | null; - /** - * Identifier for the task. - */ - taskId?: string | null; - /** - * Type of background task. - */ - type?: string | null; - } - /** - * Represents a list of tasks for a table. - */ - export interface Schema$TaskList { - /** - * List of all requested tasks. - */ - items?: Schema$Task[]; - /** - * Type of the resource. This is always "fusiontables#taskList". - */ - kind?: string | null; - /** - * Token used to access the next page of this result. No token is displayed if there are no more pages left. - */ - nextPageToken?: string | null; - /** - * Total number of tasks for the table. - */ - totalItems?: number | null; - } - /** - * Represents the contents of InfoWindow templates. - */ - export interface Schema$Template { - /** - * List of columns from which the template is to be automatically constructed. Only one of body or automaticColumns can be specified. - */ - automaticColumnNames?: string[] | null; - /** - * Body of the template. It contains HTML with {column_name} to insert values from a particular column. The body is sanitized to remove certain tags, e.g., script. Only one of body or automaticColumns can be specified. - */ - body?: string | null; - /** - * The kind of item this is. For a template, this is always fusiontables#template. - */ - kind?: string | null; - /** - * Optional name assigned to a template. - */ - name?: string | null; - /** - * Identifier for the table for which the template is defined. - */ - tableId?: string | null; - /** - * Identifier for the template, unique within the context of a particular table. - */ - templateId?: number | null; - } - /** - * Represents a list of templates for a given table. - */ - export interface Schema$TemplateList { - /** - * List of all requested templates. - */ - items?: Schema$Template[]; - /** - * The kind of item this is. For a template list, this is always fusiontables#templateList . - */ - kind?: string | null; - /** - * Token used to access the next page of this result. No token is displayed if there are no more pages left. - */ - nextPageToken?: string | null; - /** - * Total number of templates for the table. - */ - totalItems?: number | null; - } - - export class Resource$Column { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * fusiontables.column.delete - * @desc Deletes the specified column. - * @alias fusiontables.column.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.columnId Name or identifier for the column being deleted. - * @param {string} params.tableId Table from which the column is being deleted. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Column$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Column$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Column$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Column$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Column$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Column$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/fusiontables/v2/tables/{tableId}/columns/{columnId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['tableId', 'columnId'], - pathParams: ['columnId', 'tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.column.get - * @desc Retrieves a specific column by its ID. - * @alias fusiontables.column.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.columnId Name or identifier for the column that is being requested. - * @param {string} params.tableId Table to which the column belongs. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Column$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Column$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Column$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Column$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Column$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Column$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/fusiontables/v2/tables/{tableId}/columns/{columnId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['tableId', 'columnId'], - pathParams: ['columnId', 'tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.column.insert - * @desc Adds a new column to the table. - * @alias fusiontables.column.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.tableId Table for which a new column is being added. - * @param {().Column} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - insert( - params?: Params$Resource$Column$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Column$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Column$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Column$Insert - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Column$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Column$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/fusiontables/v2/tables/{tableId}/columns' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['tableId'], - pathParams: ['tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.column.list - * @desc Retrieves a list of columns. - * @alias fusiontables.column.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.maxResults Maximum number of columns to return. Default is 5. - * @param {string=} params.pageToken Continuation token specifying which result page to return. - * @param {string} params.tableId Table whose columns are being listed. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Column$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Column$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Column$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Column$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Column$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Column$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/fusiontables/v2/tables/{tableId}/columns' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['tableId'], - pathParams: ['tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.column.patch - * @desc Updates the name or type of an existing column. This method supports patch semantics. - * @alias fusiontables.column.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.columnId Name or identifier for the column that is being updated. - * @param {string} params.tableId Table for which the column is being updated. - * @param {().Column} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - patch( - params?: Params$Resource$Column$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Column$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Column$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Column$Patch - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Column$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Column$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/fusiontables/v2/tables/{tableId}/columns/{columnId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['tableId', 'columnId'], - pathParams: ['columnId', 'tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.column.update - * @desc Updates the name or type of an existing column. - * @alias fusiontables.column.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.columnId Name or identifier for the column that is being updated. - * @param {string} params.tableId Table for which the column is being updated. - * @param {().Column} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - update( - params?: Params$Resource$Column$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Column$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Column$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Column$Update - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Column$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Column$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/fusiontables/v2/tables/{tableId}/columns/{columnId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['tableId', 'columnId'], - pathParams: ['columnId', 'tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Column$Delete extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Name or identifier for the column being deleted. - */ - columnId?: string; - /** - * Table from which the column is being deleted. - */ - tableId?: string; - } - export interface Params$Resource$Column$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Name or identifier for the column that is being requested. - */ - columnId?: string; - /** - * Table to which the column belongs. - */ - tableId?: string; - } - export interface Params$Resource$Column$Insert extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Table for which a new column is being added. - */ - tableId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Column; - } - export interface Params$Resource$Column$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Maximum number of columns to return. Default is 5. - */ - maxResults?: number; - /** - * Continuation token specifying which result page to return. - */ - pageToken?: string; - /** - * Table whose columns are being listed. - */ - tableId?: string; - } - export interface Params$Resource$Column$Patch extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Name or identifier for the column that is being updated. - */ - columnId?: string; - /** - * Table for which the column is being updated. - */ - tableId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Column; - } - export interface Params$Resource$Column$Update extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Name or identifier for the column that is being updated. - */ - columnId?: string; - /** - * Table for which the column is being updated. - */ - tableId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Column; - } - - export class Resource$Query { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * fusiontables.query.sql - * @desc Executes a Fusion Tables SQL statement, which can be any of - SELECT - INSERT - UPDATE - DELETE - SHOW - DESCRIBE - CREATE statement. - * @alias fusiontables.query.sql - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.hdrs Whether column names are included in the first row. Default is true. - * @param {string} params.sql A Fusion Tables SQL statement, which can be any of - SELECT - INSERT - UPDATE - DELETE - SHOW - DESCRIBE - CREATE - * @param {boolean=} params.typed Whether typed values are returned in the (JSON) response: numbers for numeric values and parsed geometries for KML values. Default is true. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - sql( - params?: Params$Resource$Query$Sql, - options?: MethodOptions - ): GaxiosPromise; - sql( - params: Params$Resource$Query$Sql, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - sql( - params: Params$Resource$Query$Sql, - callback: BodyResponseCallback - ): void; - sql(callback: BodyResponseCallback): void; - sql( - paramsOrCallback?: - | Params$Resource$Query$Sql - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Query$Sql; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Query$Sql; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/fusiontables/v2/query').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['sql'], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.query.sqlGet - * @desc Executes a SQL statement which can be any of - SELECT - SHOW - DESCRIBE - * @alias fusiontables.query.sqlGet - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.hdrs Whether column names are included (in the first row). Default is true. - * @param {string} params.sql A SQL statement which can be any of - SELECT - SHOW - DESCRIBE - * @param {boolean=} params.typed Whether typed values are returned in the (JSON) response: numbers for numeric values and parsed geometries for KML values. Default is true. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - sqlGet( - params?: Params$Resource$Query$Sqlget, - options?: MethodOptions - ): GaxiosPromise; - sqlGet( - params: Params$Resource$Query$Sqlget, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - sqlGet( - params: Params$Resource$Query$Sqlget, - callback: BodyResponseCallback - ): void; - sqlGet(callback: BodyResponseCallback): void; - sqlGet( - paramsOrCallback?: - | Params$Resource$Query$Sqlget - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Query$Sqlget; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Query$Sqlget; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/fusiontables/v2/query').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['sql'], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Query$Sql extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Whether column names are included in the first row. Default is true. - */ - hdrs?: boolean; - /** - * A Fusion Tables SQL statement, which can be any of - SELECT - INSERT - UPDATE - DELETE - SHOW - DESCRIBE - CREATE - */ - sql?: string; - /** - * Whether typed values are returned in the (JSON) response: numbers for numeric values and parsed geometries for KML values. Default is true. - */ - typed?: boolean; - } - export interface Params$Resource$Query$Sqlget extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Whether column names are included (in the first row). Default is true. - */ - hdrs?: boolean; - /** - * A SQL statement which can be any of - SELECT - SHOW - DESCRIBE - */ - sql?: string; - /** - * Whether typed values are returned in the (JSON) response: numbers for numeric values and parsed geometries for KML values. Default is true. - */ - typed?: boolean; - } - - export class Resource$Style { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * fusiontables.style.delete - * @desc Deletes a style. - * @alias fusiontables.style.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer} params.styleId Identifier (within a table) for the style being deleted - * @param {string} params.tableId Table from which the style is being deleted - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Style$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Style$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Style$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Style$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Style$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Style$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/fusiontables/v2/tables/{tableId}/styles/{styleId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['tableId', 'styleId'], - pathParams: ['styleId', 'tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.style.get - * @desc Gets a specific style. - * @alias fusiontables.style.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer} params.styleId Identifier (integer) for a specific style in a table - * @param {string} params.tableId Table to which the requested style belongs - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Style$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Style$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Style$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Style$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Style$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Style$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/fusiontables/v2/tables/{tableId}/styles/{styleId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['tableId', 'styleId'], - pathParams: ['styleId', 'tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.style.insert - * @desc Adds a new style for the table. - * @alias fusiontables.style.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.tableId Table for which a new style is being added - * @param {().StyleSetting} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - insert( - params?: Params$Resource$Style$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Style$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Style$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Style$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Style$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Style$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/fusiontables/v2/tables/{tableId}/styles').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['tableId'], - pathParams: ['tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.style.list - * @desc Retrieves a list of styles. - * @alias fusiontables.style.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.maxResults Maximum number of styles to return. Optional. Default is 5. - * @param {string=} params.pageToken Continuation token specifying which result page to return. Optional. - * @param {string} params.tableId Table whose styles are being listed - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Style$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Style$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Style$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Style$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Style$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Style$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/fusiontables/v2/tables/{tableId}/styles').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['tableId'], - pathParams: ['tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.style.patch - * @desc Updates an existing style. This method supports patch semantics. - * @alias fusiontables.style.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer} params.styleId Identifier (within a table) for the style being updated. - * @param {string} params.tableId Table whose style is being updated. - * @param {().StyleSetting} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - patch( - params?: Params$Resource$Style$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Style$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Style$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Style$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Style$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Style$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/fusiontables/v2/tables/{tableId}/styles/{styleId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['tableId', 'styleId'], - pathParams: ['styleId', 'tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.style.update - * @desc Updates an existing style. - * @alias fusiontables.style.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer} params.styleId Identifier (within a table) for the style being updated. - * @param {string} params.tableId Table whose style is being updated. - * @param {().StyleSetting} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - update( - params?: Params$Resource$Style$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Style$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Style$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Style$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Style$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Style$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/fusiontables/v2/tables/{tableId}/styles/{styleId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['tableId', 'styleId'], - pathParams: ['styleId', 'tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Style$Delete extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Identifier (within a table) for the style being deleted - */ - styleId?: number; - /** - * Table from which the style is being deleted - */ - tableId?: string; - } - export interface Params$Resource$Style$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Identifier (integer) for a specific style in a table - */ - styleId?: number; - /** - * Table to which the requested style belongs - */ - tableId?: string; - } - export interface Params$Resource$Style$Insert extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Table for which a new style is being added - */ - tableId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$StyleSetting; - } - export interface Params$Resource$Style$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Maximum number of styles to return. Optional. Default is 5. - */ - maxResults?: number; - /** - * Continuation token specifying which result page to return. Optional. - */ - pageToken?: string; - /** - * Table whose styles are being listed - */ - tableId?: string; - } - export interface Params$Resource$Style$Patch extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Identifier (within a table) for the style being updated. - */ - styleId?: number; - /** - * Table whose style is being updated. - */ - tableId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$StyleSetting; - } - export interface Params$Resource$Style$Update extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Identifier (within a table) for the style being updated. - */ - styleId?: number; - /** - * Table whose style is being updated. - */ - tableId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$StyleSetting; - } - - export class Resource$Table { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * fusiontables.table.copy - * @desc Copies a table. - * @alias fusiontables.table.copy - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.copyPresentation Whether to also copy tabs, styles, and templates. Default is false. - * @param {string} params.tableId ID of the table that is being copied. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - copy( - params?: Params$Resource$Table$Copy, - options?: MethodOptions - ): GaxiosPromise; - copy( - params: Params$Resource$Table$Copy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - copy( - params: Params$Resource$Table$Copy, - callback: BodyResponseCallback - ): void; - copy(callback: BodyResponseCallback): void; - copy( - paramsOrCallback?: - | Params$Resource$Table$Copy - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Table$Copy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Table$Copy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/fusiontables/v2/tables/{tableId}/copy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['tableId'], - pathParams: ['tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.table.delete - * @desc Deletes a table. - * @alias fusiontables.table.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.tableId ID of the table to be deleted. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Table$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Table$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Table$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Table$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Table$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Table$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/fusiontables/v2/tables/{tableId}').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['tableId'], - pathParams: ['tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.table.get - * @desc Retrieves a specific table by its ID. - * @alias fusiontables.table.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.tableId Identifier for the table being requested. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Table$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Table$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Table$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Table$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Table$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Table$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/fusiontables/v2/tables/{tableId}').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['tableId'], - pathParams: ['tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.table.importRows - * @desc Imports more rows into a table. - * @alias fusiontables.table.importRows - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.delimiter The delimiter used to separate cell values. This can only consist of a single character. Default is ,. - * @param {string=} params.encoding The encoding of the content. Default is UTF-8. Use auto-detect if you are unsure of the encoding. - * @param {integer=} params.endLine The index of the line up to which data will be imported. Default is to import the entire file. If endLine is negative, it is an offset from the end of the file; the imported content will exclude the last endLine lines. - * @param {boolean=} params.isStrict Whether the imported CSV must have the same number of values for each row. If false, rows with fewer values will be padded with empty values. Default is true. - * @param {integer=} params.startLine The index of the first line from which to start importing, inclusive. Default is 0. - * @param {string} params.tableId The table into which new rows are being imported. - * @param {object} params.media Media object - * @param {string} params.media.mimeType Media mime-type - * @param {string|object} params.media.body Media body contents - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - importRows( - params?: Params$Resource$Table$Importrows, - options?: MethodOptions - ): GaxiosPromise; - importRows( - params: Params$Resource$Table$Importrows, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - importRows( - params: Params$Resource$Table$Importrows, - callback: BodyResponseCallback - ): void; - importRows(callback: BodyResponseCallback): void; - importRows( - paramsOrCallback?: - | Params$Resource$Table$Importrows - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Table$Importrows; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Table$Importrows; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/fusiontables/v2/tables/{tableId}/import').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - mediaUrl: ( - rootUrl + '/upload/fusiontables/v2/tables/{tableId}/import' - ).replace(/([^:]\/)\/+/g, '$1'), - requiredParams: ['tableId'], - pathParams: ['tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.table.importTable - * @desc Imports a new table. - * @alias fusiontables.table.importTable - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.delimiter The delimiter used to separate cell values. This can only consist of a single character. Default is ,. - * @param {string=} params.encoding The encoding of the content. Default is UTF-8. Use auto-detect if you are unsure of the encoding. - * @param {string} params.name The name to be assigned to the new table. - * @param {object} params.media Media object - * @param {string} params.media.mimeType Media mime-type - * @param {string|object} params.media.body Media body contents - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - importTable( - params?: Params$Resource$Table$Importtable, - options?: MethodOptions - ): GaxiosPromise; - importTable( - params: Params$Resource$Table$Importtable, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - importTable( - params: Params$Resource$Table$Importtable, - callback: BodyResponseCallback - ): void; - importTable(callback: BodyResponseCallback): void; - importTable( - paramsOrCallback?: - | Params$Resource$Table$Importtable - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Table$Importtable; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Table$Importtable; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/fusiontables/v2/tables/import').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - mediaUrl: (rootUrl + '/upload/fusiontables/v2/tables/import').replace( - /([^:]\/)\/+/g, - '$1' - ), - requiredParams: ['name'], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.table.insert - * @desc Creates a new table. - * @alias fusiontables.table.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {().Table} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - insert( - params?: Params$Resource$Table$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Table$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Table$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Table$Insert - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Table$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Table$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/fusiontables/v2/tables').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.table.list - * @desc Retrieves a list of tables a user owns. - * @alias fusiontables.table.list - * @memberOf! () - * - * @param {object=} params Parameters for request - * @param {integer=} params.maxResults Maximum number of tables to return. Default is 5. - * @param {string=} params.pageToken Continuation token specifying which result page to return. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Table$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Table$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Table$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Table$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Table$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Table$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/fusiontables/v2/tables').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.table.patch - * @desc Updates an existing table. Unless explicitly requested, only the name, description, and attribution will be updated. This method supports patch semantics. - * @alias fusiontables.table.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.replaceViewDefinition Whether the view definition is also updated. The specified view definition replaces the existing one. Only a view can be updated with a new definition. - * @param {string} params.tableId ID of the table that is being updated. - * @param {().Table} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - patch( - params?: Params$Resource$Table$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Table$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Table$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Table$Patch - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Table$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Table$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/fusiontables/v2/tables/{tableId}').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['tableId'], - pathParams: ['tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.table.refetchSheet - * @desc Replaces rows of the table with the rows of the spreadsheet that is first imported from. Current rows remain visible until all replacement rows are ready. - * @alias fusiontables.table.refetchSheet - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.tableId Table whose rows will be replaced from the spreadsheet. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - refetchSheet( - params?: Params$Resource$Table$Refetchsheet, - options?: MethodOptions - ): GaxiosPromise; - refetchSheet( - params: Params$Resource$Table$Refetchsheet, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - refetchSheet( - params: Params$Resource$Table$Refetchsheet, - callback: BodyResponseCallback - ): void; - refetchSheet(callback: BodyResponseCallback): void; - refetchSheet( - paramsOrCallback?: - | Params$Resource$Table$Refetchsheet - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Table$Refetchsheet; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Table$Refetchsheet; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/fusiontables/v2/tables/{tableId}/refetch' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['tableId'], - pathParams: ['tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.table.replaceRows - * @desc Replaces rows of an existing table. Current rows remain visible until all replacement rows are ready. - * @alias fusiontables.table.replaceRows - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.delimiter The delimiter used to separate cell values. This can only consist of a single character. Default is ,. - * @param {string=} params.encoding The encoding of the content. Default is UTF-8. Use 'auto-detect' if you are unsure of the encoding. - * @param {integer=} params.endLine The index of the line up to which data will be imported. Default is to import the entire file. If endLine is negative, it is an offset from the end of the file; the imported content will exclude the last endLine lines. - * @param {boolean=} params.isStrict Whether the imported CSV must have the same number of column values for each row. If true, throws an exception if the CSV does not have the same number of columns. If false, rows with fewer column values will be padded with empty values. Default is true. - * @param {integer=} params.startLine The index of the first line from which to start importing, inclusive. Default is 0. - * @param {string} params.tableId Table whose rows will be replaced. - * @param {object} params.media Media object - * @param {string} params.media.mimeType Media mime-type - * @param {string|object} params.media.body Media body contents - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - replaceRows( - params?: Params$Resource$Table$Replacerows, - options?: MethodOptions - ): GaxiosPromise; - replaceRows( - params: Params$Resource$Table$Replacerows, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - replaceRows( - params: Params$Resource$Table$Replacerows, - callback: BodyResponseCallback - ): void; - replaceRows(callback: BodyResponseCallback): void; - replaceRows( - paramsOrCallback?: - | Params$Resource$Table$Replacerows - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Table$Replacerows; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Table$Replacerows; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/fusiontables/v2/tables/{tableId}/replace' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - mediaUrl: ( - rootUrl + '/upload/fusiontables/v2/tables/{tableId}/replace' - ).replace(/([^:]\/)\/+/g, '$1'), - requiredParams: ['tableId'], - pathParams: ['tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.table.update - * @desc Updates an existing table. Unless explicitly requested, only the name, description, and attribution will be updated. - * @alias fusiontables.table.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.replaceViewDefinition Whether the view definition is also updated. The specified view definition replaces the existing one. Only a view can be updated with a new definition. - * @param {string} params.tableId ID of the table that is being updated. - * @param {().Table} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - update( - params?: Params$Resource$Table$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Table$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Table$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Table$Update - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Table$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Table$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/fusiontables/v2/tables/{tableId}').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['tableId'], - pathParams: ['tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Table$Copy extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Whether to also copy tabs, styles, and templates. Default is false. - */ - copyPresentation?: boolean; - /** - * ID of the table that is being copied. - */ - tableId?: string; - } - export interface Params$Resource$Table$Delete extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * ID of the table to be deleted. - */ - tableId?: string; - } - export interface Params$Resource$Table$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Identifier for the table being requested. - */ - tableId?: string; - } - export interface Params$Resource$Table$Importrows extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The delimiter used to separate cell values. This can only consist of a single character. Default is ,. - */ - delimiter?: string; - /** - * The encoding of the content. Default is UTF-8. Use auto-detect if you are unsure of the encoding. - */ - encoding?: string; - /** - * The index of the line up to which data will be imported. Default is to import the entire file. If endLine is negative, it is an offset from the end of the file; the imported content will exclude the last endLine lines. - */ - endLine?: number; - /** - * Whether the imported CSV must have the same number of values for each row. If false, rows with fewer values will be padded with empty values. Default is true. - */ - isStrict?: boolean; - /** - * The index of the first line from which to start importing, inclusive. Default is 0. - */ - startLine?: number; - /** - * The table into which new rows are being imported. - */ - tableId?: string; - - /** - * Media metadata - */ - media?: { - /** - * Media mime-type - */ - mimeType?: string; - - /** - * Media body contents - */ - body?: any; - }; - } - export interface Params$Resource$Table$Importtable - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The delimiter used to separate cell values. This can only consist of a single character. Default is ,. - */ - delimiter?: string; - /** - * The encoding of the content. Default is UTF-8. Use auto-detect if you are unsure of the encoding. - */ - encoding?: string; - /** - * The name to be assigned to the new table. - */ - name?: string; - - /** - * Media metadata - */ - media?: { - /** - * Media mime-type - */ - mimeType?: string; - - /** - * Media body contents - */ - body?: any; - }; - } - export interface Params$Resource$Table$Insert extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Request body metadata - */ - requestBody?: Schema$Table; - } - export interface Params$Resource$Table$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Maximum number of tables to return. Default is 5. - */ - maxResults?: number; - /** - * Continuation token specifying which result page to return. - */ - pageToken?: string; - } - export interface Params$Resource$Table$Patch extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Whether the view definition is also updated. The specified view definition replaces the existing one. Only a view can be updated with a new definition. - */ - replaceViewDefinition?: boolean; - /** - * ID of the table that is being updated. - */ - tableId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Table; - } - export interface Params$Resource$Table$Refetchsheet - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Table whose rows will be replaced from the spreadsheet. - */ - tableId?: string; - } - export interface Params$Resource$Table$Replacerows - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The delimiter used to separate cell values. This can only consist of a single character. Default is ,. - */ - delimiter?: string; - /** - * The encoding of the content. Default is UTF-8. Use 'auto-detect' if you are unsure of the encoding. - */ - encoding?: string; - /** - * The index of the line up to which data will be imported. Default is to import the entire file. If endLine is negative, it is an offset from the end of the file; the imported content will exclude the last endLine lines. - */ - endLine?: number; - /** - * Whether the imported CSV must have the same number of column values for each row. If true, throws an exception if the CSV does not have the same number of columns. If false, rows with fewer column values will be padded with empty values. Default is true. - */ - isStrict?: boolean; - /** - * The index of the first line from which to start importing, inclusive. Default is 0. - */ - startLine?: number; - /** - * Table whose rows will be replaced. - */ - tableId?: string; - - /** - * Media metadata - */ - media?: { - /** - * Media mime-type - */ - mimeType?: string; - - /** - * Media body contents - */ - body?: any; - }; - } - export interface Params$Resource$Table$Update extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Whether the view definition is also updated. The specified view definition replaces the existing one. Only a view can be updated with a new definition. - */ - replaceViewDefinition?: boolean; - /** - * ID of the table that is being updated. - */ - tableId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Table; - } - - export class Resource$Task { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * fusiontables.task.delete - * @desc Deletes a specific task by its ID, unless that task has already started running. - * @alias fusiontables.task.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.tableId Table from which the task is being deleted. - * @param {string} params.taskId The identifier of the task to delete. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Task$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Task$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Task$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Task$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Task$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Task$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/fusiontables/v2/tables/{tableId}/tasks/{taskId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['tableId', 'taskId'], - pathParams: ['tableId', 'taskId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.task.get - * @desc Retrieves a specific task by its ID. - * @alias fusiontables.task.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.tableId Table to which the task belongs. - * @param {string} params.taskId The identifier of the task to get. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Task$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Task$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Task$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Task$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Task$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Task$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/fusiontables/v2/tables/{tableId}/tasks/{taskId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['tableId', 'taskId'], - pathParams: ['tableId', 'taskId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.task.list - * @desc Retrieves a list of tasks. - * @alias fusiontables.task.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.maxResults Maximum number of tasks to return. Default is 5. - * @param {string=} params.pageToken Continuation token specifying which result page to return. - * @param {integer=} params.startIndex Index of the first result returned in the current page. - * @param {string} params.tableId Table whose tasks are being listed. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Task$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Task$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Task$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Task$List - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Task$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Task$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/fusiontables/v2/tables/{tableId}/tasks').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['tableId'], - pathParams: ['tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Task$Delete extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Table from which the task is being deleted. - */ - tableId?: string; - /** - * The identifier of the task to delete. - */ - taskId?: string; - } - export interface Params$Resource$Task$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Table to which the task belongs. - */ - tableId?: string; - /** - * The identifier of the task to get. - */ - taskId?: string; - } - export interface Params$Resource$Task$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Maximum number of tasks to return. Default is 5. - */ - maxResults?: number; - /** - * Continuation token specifying which result page to return. - */ - pageToken?: string; - /** - * Index of the first result returned in the current page. - */ - startIndex?: number; - /** - * Table whose tasks are being listed. - */ - tableId?: string; - } - - export class Resource$Template { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * fusiontables.template.delete - * @desc Deletes a template - * @alias fusiontables.template.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.tableId Table from which the template is being deleted - * @param {integer} params.templateId Identifier for the template which is being deleted - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Template$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Template$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Template$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Template$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Template$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Template$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/fusiontables/v2/tables/{tableId}/templates/{templateId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['tableId', 'templateId'], - pathParams: ['tableId', 'templateId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.template.get - * @desc Retrieves a specific template by its id - * @alias fusiontables.template.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.tableId Table to which the template belongs - * @param {integer} params.templateId Identifier for the template that is being requested - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Template$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Template$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Template$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Template$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Template$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Template$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/fusiontables/v2/tables/{tableId}/templates/{templateId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['tableId', 'templateId'], - pathParams: ['tableId', 'templateId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.template.insert - * @desc Creates a new template for the table. - * @alias fusiontables.template.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.tableId Table for which a new template is being created - * @param {().Template} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - insert( - params?: Params$Resource$Template$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Template$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Template$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Template$Insert - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Template$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Template$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/fusiontables/v2/tables/{tableId}/templates' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['tableId'], - pathParams: ['tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.template.list - * @desc Retrieves a list of templates. - * @alias fusiontables.template.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.maxResults Maximum number of templates to return. Optional. Default is 5. - * @param {string=} params.pageToken Continuation token specifying which results page to return. Optional. - * @param {string} params.tableId Identifier for the table whose templates are being requested - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Template$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Template$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Template$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Template$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Template$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Template$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/fusiontables/v2/tables/{tableId}/templates' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['tableId'], - pathParams: ['tableId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.template.patch - * @desc Updates an existing template. This method supports patch semantics. - * @alias fusiontables.template.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.tableId Table to which the updated template belongs - * @param {integer} params.templateId Identifier for the template that is being updated - * @param {().Template} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - patch( - params?: Params$Resource$Template$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Template$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Template$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Template$Patch - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Template$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Template$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/fusiontables/v2/tables/{tableId}/templates/{templateId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['tableId', 'templateId'], - pathParams: ['tableId', 'templateId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * fusiontables.template.update - * @desc Updates an existing template - * @alias fusiontables.template.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.tableId Table to which the updated template belongs - * @param {integer} params.templateId Identifier for the template that is being updated - * @param {().Template} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - update( - params?: Params$Resource$Template$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Template$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Template$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Template$Update - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Template$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Template$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/fusiontables/v2/tables/{tableId}/templates/{templateId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['tableId', 'templateId'], - pathParams: ['tableId', 'templateId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Template$Delete extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Table from which the template is being deleted - */ - tableId?: string; - /** - * Identifier for the template which is being deleted - */ - templateId?: number; - } - export interface Params$Resource$Template$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Table to which the template belongs - */ - tableId?: string; - /** - * Identifier for the template that is being requested - */ - templateId?: number; - } - export interface Params$Resource$Template$Insert extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Table for which a new template is being created - */ - tableId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Template; - } - export interface Params$Resource$Template$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Maximum number of templates to return. Optional. Default is 5. - */ - maxResults?: number; - /** - * Continuation token specifying which results page to return. Optional. - */ - pageToken?: string; - /** - * Identifier for the table whose templates are being requested - */ - tableId?: string; - } - export interface Params$Resource$Template$Patch extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Table to which the updated template belongs - */ - tableId?: string; - /** - * Identifier for the template that is being updated - */ - templateId?: number; - - /** - * Request body metadata - */ - requestBody?: Schema$Template; - } - export interface Params$Resource$Template$Update extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Table to which the updated template belongs - */ - tableId?: string; - /** - * Identifier for the template that is being updated - */ - templateId?: number; - - /** - * Request body metadata - */ - requestBody?: Schema$Template; - } -} diff --git a/src/apis/gamesManagement/v1management.ts b/src/apis/gamesManagement/v1management.ts index 811edf0e0b8..11a9f3802ef 100644 --- a/src/apis/gamesManagement/v1management.ts +++ b/src/apis/gamesManagement/v1management.ts @@ -905,7 +905,7 @@ export namespace gamesManagement_v1management { /** * gamesManagement.events.reset - * @desc Resets all player progress on the event with the given ID for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application. All quests for this player that use the event will also be reset. + * @desc Resets all player progress on the event with the given ID for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application. * @alias gamesManagement.events.reset * @memberOf! () * @@ -975,7 +975,7 @@ export namespace gamesManagement_v1management { /** * gamesManagement.events.resetAll - * @desc Resets all player progress on all events for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application. All quests for this player will also be reset. + * @desc Resets all player progress on all events for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application. * @alias gamesManagement.events.resetAll * @memberOf! () * @@ -1045,7 +1045,7 @@ export namespace gamesManagement_v1management { /** * gamesManagement.events.resetAllForAllPlayers - * @desc Resets all draft events for all players. This method is only available to user accounts for your developer console. All quests that use any of these events will also be reset. + * @desc Resets all draft events for all players. This method is only available to user accounts for your developer console. * @alias gamesManagement.events.resetAllForAllPlayers * @memberOf! () * @@ -1115,7 +1115,7 @@ export namespace gamesManagement_v1management { /** * gamesManagement.events.resetForAllPlayers - * @desc Resets the event with the given ID for all players. This method is only available to user accounts for your developer console. Only draft events can be reset. All quests that use the event will also be reset. + * @desc Resets the event with the given ID for all players. This method is only available to user accounts for your developer console. Only draft events can be reset. * @alias gamesManagement.events.resetForAllPlayers * @memberOf! () * @@ -1187,7 +1187,7 @@ export namespace gamesManagement_v1management { /** * gamesManagement.events.resetMultipleForAllPlayers - * @desc Resets events with the given IDs for all players. This method is only available to user accounts for your developer console. Only draft events may be reset. All quests that use any of the events will also be reset. + * @desc Resets events with the given IDs for all players. This method is only available to user accounts for your developer console. Only draft events may be reset. * @alias gamesManagement.events.resetMultipleForAllPlayers * @memberOf! () * diff --git a/src/apis/gmail/v1.ts b/src/apis/gmail/v1.ts index 2464d7a3b5d..db0f3e8e6bf 100644 --- a/src/apis/gmail/v1.ts +++ b/src/apis/gmail/v1.ts @@ -395,7 +395,7 @@ export namespace gmail_v1 { } export interface Schema$ListDraftsResponse { /** - * List of drafts. + * List of drafts. Note that the Message property in each Draft resource only contains an id and a threadId. The messages.get method can fetch additional message details. */ drafts?: Schema$Draft[]; /** @@ -441,7 +441,7 @@ export namespace gmail_v1 { } export interface Schema$ListLabelsResponse { /** - * List of labels. + * List of labels. Note that each label resource only contains an id, name, messageListVisibility, labelListVisibility, and type. The labels.get method can fetch additional label details. */ labels?: Schema$Label[]; } @@ -4548,7 +4548,7 @@ export namespace gmail_v1 { /** * gmail.users.settings.delegates.create - * @desc Adds a delegate with its verification status set directly to accepted, without sending any verification email. The delegate user must be a member of the same G Suite organization as the delegator user. Gmail imposes limtations on the number of delegates and delegators each user in a G Suite organization can have. These limits depend on your organization, but in general each user can have up to 25 delegates and up to 10 delegators. Note that a delegate user must be referred to by their primary email address, and not an email alias. Also note that when a new delegate is created, there may be up to a one minute delay before the new delegate is available for use. This method is only available to service account clients that have been delegated domain-wide authority. + * @desc Adds a delegate with its verification status set directly to accepted, without sending any verification email. The delegate user must be a member of the same G Suite organization as the delegator user. Gmail imposes limitations on the number of delegates and delegators each user in a G Suite organization can have. These limits depend on your organization, but in general each user can have up to 25 delegates and up to 10 delegators. Note that a delegate user must be referred to by their primary email address, and not an email alias. Also note that when a new delegate is created, there may be up to a one minute delay before the new delegate is available for use. This method is only available to service account clients that have been delegated domain-wide authority. * @alias gmail.users.settings.delegates.create * @memberOf! () * diff --git a/src/apis/healthcare/v1beta1.ts b/src/apis/healthcare/v1beta1.ts index c8741417bd4..1b46d31af7c 100644 --- a/src/apis/healthcare/v1beta1.ts +++ b/src/apis/healthcare/v1beta1.ts @@ -150,7 +150,7 @@ export namespace healthcare_v1beta1 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -470,6 +470,10 @@ export namespace healthcare_v1beta1 { * If non-empty, publish all resource modifications of this FHIR store to this destination. The Cloud Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, "action":"CreateResource". */ notificationConfig?: Schema$NotificationConfig; + /** + * The FHIR specification version that this FHIR store supports natively. This field is immutable after store creation. Requests are rejected if they contain FHIR resources of a different version. An empty value is treated as STU3. + */ + version?: string | null; } /** * Specifies FHIR paths to match, and how to handle de-identification of matching fields. @@ -1015,7 +1019,7 @@ export namespace healthcare_v1beta1 { value?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -1023,15 +1027,15 @@ export namespace healthcare_v1beta1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if the incoming policy version does not meet the requirements for modifying the stored policy. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a binding (conditional or unconditional) from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, version compliance checks against the stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } @@ -1087,7 +1091,7 @@ export namespace healthcare_v1beta1 { */ export interface Schema$SearchResourcesRequest { /** - * The FHIR resource type to search, such as Patient or Observation. For a complete list, see the [FHIR Resource Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). + * The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html)). */ resourceType?: string | null; } @@ -1482,12 +1486,16 @@ export namespace healthcare_v1beta1 { export class Resource$Projects$Locations$Datasets { context: APIRequestContext; + annotationStores: Resource$Projects$Locations$Datasets$Annotationstores; dicomStores: Resource$Projects$Locations$Datasets$Dicomstores; fhirStores: Resource$Projects$Locations$Datasets$Fhirstores; hl7V2Stores: Resource$Projects$Locations$Datasets$Hl7v2stores; operations: Resource$Projects$Locations$Datasets$Operations; constructor(context: APIRequestContext) { this.context = context; + this.annotationStores = new Resource$Projects$Locations$Datasets$Annotationstores( + this.context + ); this.dicomStores = new Resource$Projects$Locations$Datasets$Dicomstores( this.context ); @@ -2777,6 +2785,292 @@ export namespace healthcare_v1beta1 { requestBody?: Schema$TestIamPermissionsRequest; } + export class Resource$Projects$Locations$Datasets$Annotationstores { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * healthcare.projects.locations.datasets.annotationStores.getIamPolicy + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * @alias healthcare.projects.locations.datasets.annotationStores.getIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIamPolicy( + params?: Params$Resource$Projects$Locations$Datasets$Annotationstores$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Datasets$Annotationstores$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Datasets$Annotationstores$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Annotationstores$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Annotationstores$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datasets$Annotationstores$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * healthcare.projects.locations.datasets.annotationStores.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + * @alias healthcare.projects.locations.datasets.annotationStores.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. + * @param {().SetIamPolicyRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setIamPolicy( + params?: Params$Resource$Projects$Locations$Datasets$Annotationstores$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Datasets$Annotationstores$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Datasets$Annotationstores$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Annotationstores$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Annotationstores$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datasets$Annotationstores$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * healthcare.projects.locations.datasets.annotationStores.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @alias healthcare.projects.locations.datasets.annotationStores.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. + * @param {().TestIamPermissionsRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Projects$Locations$Datasets$Annotationstores$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Datasets$Annotationstores$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Datasets$Annotationstores$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Annotationstores$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Annotationstores$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datasets$Annotationstores$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Getiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Setiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + export class Resource$Projects$Locations$Datasets$Dicomstores { context: APIRequestContext; studies: Resource$Projects$Locations$Datasets$Dicomstores$Studies; @@ -8673,7 +8967,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.capabilities - * @desc Gets the FHIR [capability statement](http://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html) for the store, which contains a description of functionality supported by the server. Implements the FHIR standard [capabilities interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#capabilities). On success, the response body will contain a JSON-encoded representation of a `CapabilityStatement` resource. + * @desc Gets the FHIR capability statement ([STU3](http://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html)), or the [conformance statement](http://hl7.org/implement/standards/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#capabilities)), or the [conformance interaction](http://hl7.org/implement/standards/fhir/DSTU2/http.html#conformance) in the DSTU2 case. On success, the response body will contain a JSON-encoded representation of a `CapabilityStatement` resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -8791,7 +9085,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.conditionalDelete - * @desc Deletes FHIR resources that match a search query. Implements the FHIR standard [conditional delete interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.13.1). If multiple resources match, all of them will be deleted. Search terms are provided as query parameters following the same pattern as the search method. Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources will be moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. + * @desc Deletes FHIR resources that match a search query. Implements the FHIR standard conditional delete interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.12.1), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.13.1)). If multiple resources match, all of them will be deleted. Search terms are provided as query parameters following the same pattern as the search method. Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources will be moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. * @example * * // BEFORE RUNNING: * // --------------- @@ -8845,7 +9139,7 @@ export namespace healthcare_v1beta1 { * * @param {object} params Parameters for request * @param {string} params.parent The name of the FHIR store this resource belongs to. - * @param {string} params.type The FHIR resource type to delete, such as Patient or Observation. For a complete list, see the [FHIR Resource Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). + * @param {string} params.type The FHIR resource type to delete, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html)). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -8912,7 +9206,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.conditionalPatch - * @desc If a resource is found based on the search criteria specified in the query parameters, updates part of that resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard [conditional patch interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#patch). Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request will return a `412 Precondition Failed` error. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body will contain a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @desc If a resource is found based on the search criteria specified in the query parameters, updates part of that resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard conditional patch interaction ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#patch)). DSTU2 doesn't define a conditional patch method, but the server supports it in the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request will return a `412 Precondition Failed` error. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body will contain a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. * @example * * // BEFORE RUNNING: * // --------------- @@ -8974,7 +9268,7 @@ export namespace healthcare_v1beta1 { * * @param {object} params Parameters for request * @param {string} params.parent The name of the FHIR store this resource belongs to. - * @param {string} params.type The FHIR resource type to update, such as Patient or Observation. For a complete list, see the [FHIR Resource Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). + * @param {string} params.type The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html)). * @param {().HttpBody} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -9042,7 +9336,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.conditionalUpdate - * @desc If a resource is found based on the search criteria specified in the query parameters, updates the entire contents of that resource. Implements the FHIR standard [conditional update interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#cond-update). Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request will return a `412 Precondition Failed` error. If the search criteria identify zero matches, and the supplied resource body contains an `id`, and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. If the search criteria identify zero matches, and the supplied resource body does not contain an `id`, the resource will be created with a server-assigned ID as per the create method. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body will contain a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @desc If a resource is found based on the search criteria specified in the query parameters, updates the entire contents of that resource. Implements the FHIR standard conditional update interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.10.2), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#cond-update)). Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request will return a `412 Precondition Failed` error. If the search criteria identify zero matches, and the supplied resource body contains an `id`, and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. If the search criteria identify zero matches, and the supplied resource body does not contain an `id`, the resource will be created with a server-assigned ID as per the create method. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body will contain a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. * @example * * // BEFORE RUNNING: * // --------------- @@ -9105,7 +9399,7 @@ export namespace healthcare_v1beta1 { * * @param {object} params Parameters for request * @param {string} params.parent The name of the FHIR store this resource belongs to. - * @param {string} params.type The FHIR resource type to update, such as Patient or Observation. For a complete list, see the [FHIR Resource Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). Must match the resource type in the provided content. + * @param {string} params.type The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html)). Must match the resource type in the provided content. * @param {().HttpBody} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -9173,7 +9467,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.create - * @desc Creates a FHIR resource. Implements the FHIR standard [create interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#create), which creates a new resource with a server-assigned resource ID. Also supports the FHIR standard [conditional create interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#ccreate), specified by supplying an `If-None-Exist` header containing a FHIR search query. If no resources match this search query, the server processes the create operation as normal. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body will contain a JSON-encoded representation of the resource as it was created on the server, including the server-assigned resource ID and version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @desc Creates a FHIR resource. Implements the FHIR standard create interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#create), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#create)), which creates a new resource with a server-assigned resource ID. Also supports the FHIR standard conditional create interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#ccreate), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#ccreate)), specified by supplying an `If-None-Exist` header containing a FHIR search query. If no resources match this search query, the server processes the create operation as normal. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body will contain a JSON-encoded representation of the resource as it was created on the server, including the server-assigned resource ID and version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. * @example * * // BEFORE RUNNING: * // --------------- @@ -9235,7 +9529,7 @@ export namespace healthcare_v1beta1 { * * @param {object} params Parameters for request * @param {string} params.parent The name of the FHIR store this resource belongs to. - * @param {string} params.type The FHIR resource type to create, such as Patient or Observation. For a complete list, see the [FHIR Resource Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). Must match the resource type in the provided content. + * @param {string} params.type The FHIR resource type to create, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html)). Must match the resource type in the provided content. * @param {().HttpBody} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -9303,7 +9597,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.delete - * @desc Deletes a FHIR resource. Implements the FHIR standard [delete interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#delete). Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources will be moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. + * @desc Deletes a FHIR resource. Implements the FHIR standard delete interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#delete), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#delete)). Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources will be moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. * @example * * // BEFORE RUNNING: * // --------------- @@ -9418,7 +9712,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.executeBundle - * @desc Executes all the requests in the given Bundle. Implements the FHIR standard [batch/transaction interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#transaction). Supports all interactions within a bundle, except search. This method accepts Bundles of type `batch` and `transaction`, processing them according to the [batch processing rules](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1) and [transaction processing rules](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2). The request body must contain a JSON-encoded FHIR `Bundle` resource, and the request headers must contain `Content-Type: application/fhir+json`. For a batch bundle or a successful transaction the response body will contain a JSON-encoded representation of a `Bundle` resource of type `batch-response` or `transaction-response` containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a transaction bundle, the response body will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @desc Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#transaction), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#transaction)). Supports all interactions within a bundle, except search. This method accepts Bundles of type `batch` and `transaction`, processing them according to the batch processing rules ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.1), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1)) and transaction processing rules ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.2), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2)). The request body must contain a JSON-encoded FHIR `Bundle` resource, and the request headers must contain `Content-Type: application/fhir+json`. For a batch bundle or a successful transaction the response body will contain a JSON-encoded representation of a `Bundle` resource of type `batch-response` or `transaction-response` containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a transaction bundle, the response body will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. * @example * * // BEFORE RUNNING: * // --------------- @@ -9541,7 +9835,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.history - * @desc Lists all the versions of a resource (including the current version and deleted versions) from the FHIR store. Implements the per-resource form of the FHIR standard [history interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#history). On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `history`, containing the version history sorted from most recent to oldest versions. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @desc Lists all the versions of a resource (including the current version and deleted versions) from the FHIR store. Implements the per-resource form of the FHIR standard history interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#history), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#history)). On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `history`, containing the version history sorted from most recent to oldest versions. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. * @example * * // BEFORE RUNNING: * // --------------- @@ -9592,12 +9886,11 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.at Only include resource versions that were current at some point during the time period specified in the date time value. The date parameter format is yyyy-mm-ddThh:mm:ss[Z|(+|-)hh:mm] Clients may specify any of the following: * An entire year: `_at=2019` * An entire month: `_at=2019-01` * A specific day: `_at=2019-01-20` * A specific second: `_at=2018-12-31T23:59:58Z` - * @param {integer=} params.count The maximum number of search results on a page. Defaults to 1000. * @param {string} params.name The name of the resource to retrieve. - * @param {string=} params.page DEPRECATED! Use `_page_token`. - * @param {string=} params.since Only include resource versions that were created at or after the given instant in time. The instant in time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz (for example 2015-02-07T13:28:17.239+02:00 or 2017-01-01T00:00:00Z). The time must be specified to the second and include a time zone. + * @param {string=} params._at Only include resource versions that were current at some point during the time period specified in the date time value. The date parameter format is yyyy-mm-ddThh:mm:ss[Z|(+|-)hh:mm] Clients may specify any of the following: * An entire year: `_at=2019` * An entire month: `_at=2019-01` * A specific day: `_at=2019-01-20` * A specific second: `_at=2018-12-31T23:59:58Z` + * @param {integer=} params._count The maximum number of search results on a page. Defaults to 1000. * @param {string=} params._page_token Used to retrieve the first, previous, next, or last page of resource versions when using pagination. Value should be set to the value of `_page_token` set in next or previous page links' URLs. Next and previous page are returned in the response bundle's links field, where `link.relation` is "previous" or "next". Omit `_page_token` if no previous request has been made. + * @param {string=} params._since Only include resource versions that were created at or after the given instant in time. The instant in time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz (for example 2015-02-07T13:28:17.239+02:00 or 2017-01-01T00:00:00Z). The time must be specified to the second and include a time zone. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -9664,7 +9957,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.Observation-lastn - * @desc Retrieves the N most recent `Observation` resources for a subject matching search criteria specified as query parameters, grouped by `Observation.code`, sorted from most recent to oldest. Implements the FHIR extended operation [Observation-lastn](http://hl7.org/implement/standards/fhir/STU3/observation-operations.html#lastn). Search terms are provided as query parameters following the same pattern as the search method. The following search parameters must be provided: - `subject` or `patient` to specify a subject for the Observation. - `code`, `category` or any of the composite parameters that include `code`. Any other valid Observation search parameters can also be provided. This operation accepts an additional query parameter `max`, which specifies N, the maximum number of Observations to return from each group, with a default of 1. Searches with over 1000 results are rejected. Results are counted before grouping and limiting the results with `max`. To stay within the limit, constrain these searches using Observation search parameters such as `_lastUpdated` or `date`. On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @desc Retrieves the N most recent `Observation` resources for a subject matching search criteria specified as query parameters, grouped by `Observation.code`, sorted from most recent to oldest. Implements the FHIR extended operation Observation-lastn ([STU3](http://hl7.org/implement/standards/fhir/STU3/observation-operations.html#lastn)). DSTU2 doesn't define the Observation-lastn method, but the server supports it the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. The following search parameters must be provided: - `subject` or `patient` to specify a subject for the Observation. - `code`, `category` or any of the composite parameters that include `code`. Any other valid Observation search parameters can also be provided. This operation accepts an additional query parameter `max`, which specifies N, the maximum number of Observations to return from each group, with a default of 1. Searches with over 1000 results are rejected. Results are counted before grouping and limiting the results with `max`. To stay within the limit, constrain these searches using Observation search parameters such as `_lastUpdated` or `date`. On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. * @example * * // BEFORE RUNNING: * // --------------- @@ -9781,7 +10074,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.patch - * @desc Updates part of an existing resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard [patch interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#patch). The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body will contain a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @desc Updates part of an existing resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard patch interaction ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#patch)). DSTU2 doesn't define a patch method, but the server supports it in the same way it supports STU3. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body will contain a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. * @example * * // BEFORE RUNNING: * // --------------- @@ -9955,9 +10248,9 @@ export namespace healthcare_v1beta1 { * @param {object} params Parameters for request * @param {string=} params.end The response includes records prior to the end date. If no end date is provided, all records subsequent to the start date are in scope. * @param {string} params.name Name of the `Patient` resource for which the information is required. - * @param {string=} params.pageToken Used to retrieve the next or previous page of results when using pagination. Value should be set to the value of page_token set in next or previous page links' urls. Next and previous page are returned in the response bundle's links field, where `link.relation` is "previous" or "next". Omit `page_token` if no previous request has been made. * @param {string=} params.start The response includes records subsequent to the start date. If no start date is provided, all records prior to the end date are in scope. * @param {integer=} params._count Maximum number of resources in a page. Defaults to 100. + * @param {string=} params._page_token Used to retrieve the next or previous page of results when using pagination. Value should be set to the value of page_token set in next or previous page links' urls. Next and previous page are returned in the response bundle's links field, where `link.relation` is "previous" or "next". Omit `page_token` if no previous request has been made. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -10024,7 +10317,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.read - * @desc Gets the contents of a FHIR resource. Implements the FHIR standard [read interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#read). Also supports the FHIR standard [conditional read interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#cread) specified by supplying an `If-Modified-Since` header with a date/time value or an `If-None-Match` header with an ETag value. On success, the response body will contain a JSON-encoded representation of the resource. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @desc Gets the contents of a FHIR resource. Implements the FHIR standard read interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#read), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#read)). Also supports the FHIR standard conditional read interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#cread), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#cread)) specified by supplying an `If-Modified-Since` header with a date/time value or an `If-None-Match` header with an ETag value. On success, the response body will contain a JSON-encoded representation of the resource. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. * @example * * // BEFORE RUNNING: * // --------------- @@ -10254,7 +10547,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.search - * @desc Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard [search interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#search) using the search semantics described in the [FHIR Search specification](http://hl7.org/implement/standards/fhir/STU3/search.html). Supports three methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method. The `GET` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates the search parameters that are supported on each FHIR resource. For the list of search parameters for STU3, see the [STU3 FHIR Search Parameter Registry](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html). Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`. Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. If there are additional results, the returned `Bundle` will contain pagination links. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changes and when the change is reflected in search results. + * @desc Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/search.html)). Supports three methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method. The `GET` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`. Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. If there are additional results, the returned `Bundle` will contain pagination links. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changes and when the change is reflected in search results. * @example * * // BEFORE RUNNING: * // --------------- @@ -10377,7 +10670,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.update - * @desc Updates the entire contents of a resource. Implements the FHIR standard [update interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#update). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body will contain a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @desc Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#update), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#update)). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body will contain a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. * @example * * // BEFORE RUNNING: * // --------------- @@ -10498,7 +10791,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.vread - * @desc Gets the contents of a version (current or historical) of a FHIR resource by version ID. Implements the FHIR standard [vread interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#vread). On success, the response body will contain a JSON-encoded representation of the resource. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @desc Gets the contents of a version (current or historical) of a FHIR resource by version ID. Implements the FHIR standard vread interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#vread), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#vread). On success, the response body will contain a JSON-encoded representation of the resource. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. * @example * * // BEFORE RUNNING: * // --------------- @@ -10636,7 +10929,7 @@ export namespace healthcare_v1beta1 { */ parent?: string; /** - * The FHIR resource type to delete, such as Patient or Observation. For a complete list, see the [FHIR Resource Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). + * The FHIR resource type to delete, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html)). */ type?: string; } @@ -10652,7 +10945,7 @@ export namespace healthcare_v1beta1 { */ parent?: string; /** - * The FHIR resource type to update, such as Patient or Observation. For a complete list, see the [FHIR Resource Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). + * The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html)). */ type?: string; @@ -10673,7 +10966,7 @@ export namespace healthcare_v1beta1 { */ parent?: string; /** - * The FHIR resource type to update, such as Patient or Observation. For a complete list, see the [FHIR Resource Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). Must match the resource type in the provided content. + * The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html)). Must match the resource type in the provided content. */ type?: string; @@ -10694,7 +10987,7 @@ export namespace healthcare_v1beta1 { */ parent?: string; /** - * The FHIR resource type to create, such as Patient or Observation. For a complete list, see the [FHIR Resource Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). Must match the resource type in the provided content. + * The FHIR resource type to create, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html)). Must match the resource type in the provided content. */ type?: string; @@ -10739,30 +11032,26 @@ export namespace healthcare_v1beta1 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - /** - * Only include resource versions that were current at some point during the time period specified in the date time value. The date parameter format is yyyy-mm-ddThh:mm:ss[Z|(+|-)hh:mm] Clients may specify any of the following: * An entire year: `_at=2019` * An entire month: `_at=2019-01` * A specific day: `_at=2019-01-20` * A specific second: `_at=2018-12-31T23:59:58Z` - */ - at?: string; - /** - * The maximum number of search results on a page. Defaults to 1000. - */ - count?: number; /** * The name of the resource to retrieve. */ name?: string; /** - * DEPRECATED! Use `_page_token`. + * Only include resource versions that were current at some point during the time period specified in the date time value. The date parameter format is yyyy-mm-ddThh:mm:ss[Z|(+|-)hh:mm] Clients may specify any of the following: * An entire year: `_at=2019` * An entire month: `_at=2019-01` * A specific day: `_at=2019-01-20` * A specific second: `_at=2018-12-31T23:59:58Z` */ - page?: string; + _at?: string; /** - * Only include resource versions that were created at or after the given instant in time. The instant in time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz (for example 2015-02-07T13:28:17.239+02:00 or 2017-01-01T00:00:00Z). The time must be specified to the second and include a time zone. + * The maximum number of search results on a page. Defaults to 1000. */ - since?: string; + _count?: number; /** * Used to retrieve the first, previous, next, or last page of resource versions when using pagination. Value should be set to the value of `_page_token` set in next or previous page links' URLs. Next and previous page are returned in the response bundle's links field, where `link.relation` is "previous" or "next". Omit `_page_token` if no previous request has been made. */ _page_token?: string; + /** + * Only include resource versions that were created at or after the given instant in time. The instant in time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz (for example 2015-02-07T13:28:17.239+02:00 or 2017-01-01T00:00:00Z). The time must be specified to the second and include a time zone. + */ + _since?: string; } export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Observationlastn extends StandardParameters { @@ -10808,10 +11097,6 @@ export namespace healthcare_v1beta1 { * Name of the `Patient` resource for which the information is required. */ name?: string; - /** - * Used to retrieve the next or previous page of results when using pagination. Value should be set to the value of page_token set in next or previous page links' urls. Next and previous page are returned in the response bundle's links field, where `link.relation` is "previous" or "next". Omit `page_token` if no previous request has been made. - */ - pageToken?: string; /** * The response includes records subsequent to the start date. If no start date is provided, all records prior to the end date are in scope. */ @@ -10820,6 +11105,10 @@ export namespace healthcare_v1beta1 { * Maximum number of resources in a page. Defaults to 100. */ _count?: number; + /** + * Used to retrieve the next or previous page of results when using pagination. Value should be set to the value of page_token set in next or previous page links' urls. Next and previous page are returned in the response bundle's links field, where `link.relation` is "previous" or "next". Omit `page_token` if no previous request has been made. + */ + _page_token?: string; } export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Read extends StandardParameters { @@ -12334,7 +12623,7 @@ export namespace healthcare_v1beta1 { * * @param {object} params Parameters for request * @param {string} params.name The resource name of the HL7v2 message to retrieve. - * @param {string=} params.view Specifies which parts of the Message resource to return in the response. + * @param {string=} params.view Specifies which parts of the Message resource to return in the response. When unspecified, equivalent to FULL. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -12398,7 +12687,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.hl7V2Stores.messages.ingest - * @desc Ingests a new HL7v2 message from the hospital and sends a notification to the Cloud Pub/Sub topic. Return is an HL7v2 ACK message if the message was successfully stored. Otherwise an error is returned. If an identical HL7v2 message is created twice only one resource is created on the server and no error is reported. + * @desc Ingests a new HL7v2 message from the hospital and sends a notification to the Cloud Pub/Sub topic. Return is an HL7v2 ACK message if the message was successfully stored. Otherwise an error is returned. * @example * * // BEFORE RUNNING: * // --------------- @@ -12828,7 +13117,7 @@ export namespace healthcare_v1beta1 { */ name?: string; /** - * Specifies which parts of the Message resource to return in the response. + * Specifies which parts of the Message resource to return in the response. When unspecified, equivalent to FULL. */ view?: string; } diff --git a/src/apis/iam/v1.ts b/src/apis/iam/v1.ts index 999eca2abd7..1409df99ccd 100644 --- a/src/apis/iam/v1.ts +++ b/src/apis/iam/v1.ts @@ -185,7 +185,7 @@ export namespace iam_v1 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -249,7 +249,7 @@ export namespace iam_v1 { */ accountId?: string | null; /** - * The ServiceAccount resource to create. Currently, only the following values are user assignable: `display_name` . + * The ServiceAccount resource to create. Currently, only the following values are user assignable: `display_name` and `description`. */ serviceAccount?: Schema$ServiceAccount; } @@ -287,36 +287,24 @@ export namespace iam_v1 { title?: string | null; } /** - * The request to lint a Cloud IAM policy object. LintPolicy is currently functional only for `lint_object` of type `condition`. + * The request to lint a Cloud IAM policy object. */ export interface Schema$LintPolicyRequest { - /** - * Binding object to be linted. The functionality of linting a binding is not yet implemented and if this field is set, it returns NOT_IMPLEMENTED error. - */ - binding?: Schema$Binding; /** * google.iam.v1.Binding.condition object to be linted. */ condition?: Schema$Expr; - /** - * `context` contains additional *permission-controlled* data that any lint unit may depend on, in form of `{key: value}` pairs. Currently, this field is non-operational and it will not be used during the lint operation. - */ - context?: {[key: string]: any} | null; /** * The full resource name of the policy this lint request is about. The name follows the Google Cloud Platform (GCP) resource format. For example, a GCP project with ID `my-project` will be named `//cloudresourcemanager.googleapis.com/projects/my-project`. The resource name is not used to read the policy instance from the Cloud IAM database. The candidate policy for lint has to be provided in the same request object. */ fullResourceName?: string | null; - /** - * Policy object to be linted. The functionality of linting a policy is not yet implemented and if this field is set, it returns NOT_IMPLEMENTED error. - */ - policy?: Schema$Policy; } /** * The response of a lint operation. An empty response indicates the operation was able to fully execute and no lint issue was found. */ export interface Schema$LintPolicyResponse { /** - * List of lint results sorted by a composite <severity, binding_ordinal> key, descending order of severity and ascending order of binding_ordinal. There is no certain order among the same keys. For cross-binding results (only if the input object to lint is instance of google.iam.v1.Policy), there will be a google.iam.admin.v1.LintResult for each of the involved bindings, and the associated debug_message may enumerate the other involved binding ordinal number(s). + * List of lint results sorted by `severity` in descending order. */ lintResults?: Schema$LintResult[]; } @@ -324,16 +312,12 @@ export namespace iam_v1 { * Structured response of a single validation unit. */ export interface Schema$LintResult { - /** - * 0-based index ordinality of the binding in the input object associated with this result. This field is populated only if the input object to lint is of type google.iam.v1.Policy, which can comprise more than one binding. It is set to -1 if the result is not associated with any particular binding and only targets the policy as a whole, such as results about policy size violations. - */ - bindingOrdinal?: number | null; /** * Human readable debug message associated with the issue. */ debugMessage?: string | null; /** - * The name of the field for which this lint result is about. For nested messages, `field_name` consists of names of the embedded fields separated by period character. The top-level qualifier is the input object to lint in the request. For instance, if the lint request is on a google.iam.v1.Policy and this lint result is about a condition expression of one of the input policy bindings, the field would be populated as `policy.bindings.condition.expression`. This field does not identify the ordinality of the repetitive fields (for instance bindings in a policy). + * The name of the field for which this lint result is about. For nested messages `field_name` consists of names of the embedded fields separated by period character. The top-level qualifier is the input object to lint in the request. For example, the `field_name` value `condition.expression` identifies a lint result for the `expression` field of the provided condition. */ fieldName?: string | null; /** @@ -443,7 +427,7 @@ export namespace iam_v1 { removedPermissions?: string[] | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -451,15 +435,15 @@ export namespace iam_v1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if the incoming policy version does not meet the requirements for modifying the stored policy. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a binding (conditional or unconditional) from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, version compliance checks against the stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } @@ -684,7 +668,7 @@ export namespace iam_v1 { */ export interface Schema$SignBlobRequest { /** - * The bytes to sign. + * Required. The bytes to sign. */ bytesToSign?: string | null; } @@ -706,7 +690,7 @@ export namespace iam_v1 { */ export interface Schema$SignJwtRequest { /** - * The JWT payload to sign, a JSON JWT Claim set. + * Required. The JWT payload to sign, a JSON JWT Claim set. */ payload?: string | null; } @@ -778,7 +762,7 @@ export namespace iam_v1 { /** * iam.iamPolicies.lintPolicy - * @desc Lints a Cloud IAM policy object or its sub fields. Currently supports google.iam.v1.Policy, google.iam.v1.Binding and google.iam.v1.Binding.condition. Each lint operation consists of multiple lint validation units. Validation units have the following properties: - Each unit inspects the input object in regard to a particular linting aspect and issues a google.iam.admin.v1.LintResult disclosing the result. - Domain of discourse of each unit can be either google.iam.v1.Policy, google.iam.v1.Binding, or google.iam.v1.Binding.condition depending on the purpose of the validation. - A unit may require additional data (like the list of all possible enumerable values of a particular attribute used in the policy instance) which shall be provided by the caller. Refer to the comments of google.iam.admin.v1.LintPolicyRequest.context for more details. The set of applicable validation units is determined by the Cloud IAM server and is not configurable. Regardless of any lint issues or their severities, successful calls to `lintPolicy` return an HTTP 200 OK status code. + * @desc Lints a Cloud IAM policy object or its sub fields. Currently supports google.iam.v1.Binding.condition. Each lint operation consists of multiple lint validation units. Each unit inspects the input object in regard to a particular linting aspect and issues a google.iam.admin.v1.LintResult disclosing the result. The set of applicable validation units is determined by the Cloud IAM server and is not configurable. Regardless of any lint issues or their severities, successful calls to `lintPolicy` return an HTTP 200 OK status code. * @example * * // BEFORE RUNNING: * // --------------- @@ -3166,7 +3150,7 @@ export namespace iam_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. + * @param {string} params.name Required. The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3529,7 +3513,7 @@ export namespace iam_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. + * @param {string} params.name Required. The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4170,7 +4154,7 @@ export namespace iam_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. + * @param {string} params.name Required. The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. * @param {().SignBlobRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4299,7 +4283,7 @@ export namespace iam_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. + * @param {string} params.name Required. The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. * @param {().SignJwtRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4792,7 +4776,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. + * Required. The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. */ name?: string; } @@ -4838,7 +4822,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. + * Required. The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. */ name?: string; } @@ -4920,7 +4904,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. + * Required. The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. */ name?: string; @@ -4937,7 +4921,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. + * Required. The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. */ name?: string; @@ -5065,7 +5049,7 @@ export namespace iam_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. + * @param {string} params.name Required. The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. * @param {().CreateServiceAccountKeyRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5184,7 +5168,7 @@ export namespace iam_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the service account key in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. + * @param {string} params.name Required. The resource name of the service account key in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5303,7 +5287,7 @@ export namespace iam_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the service account key in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. + * @param {string} params.name Required. The resource name of the service account key in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. * @param {string=} params.publicKeyType The output format of the public key requested. X509_PEM is the default output format. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5426,7 +5410,7 @@ export namespace iam_v1 { * * @param {object} params Parameters for request * @param {string=} params.keyTypes Filters the types of keys the user wants to include in the list response. Duplicate key types are not allowed. If no key type is provided, all keys are returned. - * @param {string} params.name The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID`, will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. + * @param {string} params.name Required. The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID`, will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5583,7 +5567,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. + * Required. The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. */ name?: string; @@ -5600,7 +5584,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the service account key in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. + * Required. The resource name of the service account key in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. */ name?: string; } @@ -5612,7 +5596,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the service account key in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. + * Required. The resource name of the service account key in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. */ name?: string; /** @@ -5632,7 +5616,7 @@ export namespace iam_v1 { */ keyTypes?: string[]; /** - * The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID`, will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. + * Required. The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID`, will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. */ name?: string; } diff --git a/src/apis/iamcredentials/v1.ts b/src/apis/iamcredentials/v1.ts index 839ca92b75c..8a561496e52 100644 --- a/src/apis/iamcredentials/v1.ts +++ b/src/apis/iamcredentials/v1.ts @@ -125,7 +125,7 @@ export namespace iamcredentials_v1 { */ lifetime?: string | null; /** - * Code to identify the scopes to be included in the OAuth 2.0 access token. See https://developers.google.com/identity/protocols/googlescopes for more information. At least one value required. + * Required. Code to identify the scopes to be included in the OAuth 2.0 access token. See https://developers.google.com/identity/protocols/googlescopes for more information. At least one value required. */ scope?: string[] | null; } @@ -141,7 +141,7 @@ export namespace iamcredentials_v1 { } export interface Schema$GenerateIdTokenRequest { /** - * The audience for the token, such as the API or account that this token grants access to. + * Required. The audience for the token, such as the API or account that this token grants access to. */ audience?: string | null; /** @@ -165,7 +165,7 @@ export namespace iamcredentials_v1 { */ delegates?: string[] | null; /** - * The bytes to sign. + * Required. The bytes to sign. */ payload?: string | null; } @@ -185,7 +185,7 @@ export namespace iamcredentials_v1 { */ delegates?: string[] | null; /** - * The JWT payload to sign: a JSON object that contains a JWT Claims Set. + * Required. The JWT payload to sign: a JSON object that contains a JWT Claims Set. */ payload?: string | null; } @@ -224,7 +224,7 @@ export namespace iamcredentials_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the service account for which the credentials are requested, in the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid. + * @param {string} params.name Required. The resource name of the service account for which the credentials are requested, in the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid. * @param {().GenerateAccessTokenRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -307,7 +307,7 @@ export namespace iamcredentials_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the service account for which the credentials are requested, in the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid. + * @param {string} params.name Required. The resource name of the service account for which the credentials are requested, in the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid. * @param {().GenerateIdTokenRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -387,7 +387,7 @@ export namespace iamcredentials_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the service account for which the credentials are requested, in the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid. + * @param {string} params.name Required. The resource name of the service account for which the credentials are requested, in the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid. * @param {().SignBlobRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -463,7 +463,7 @@ export namespace iamcredentials_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the service account for which the credentials are requested, in the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid. + * @param {string} params.name Required. The resource name of the service account for which the credentials are requested, in the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid. * @param {().SignJwtRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -541,7 +541,7 @@ export namespace iamcredentials_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the service account for which the credentials are requested, in the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid. + * Required. The resource name of the service account for which the credentials are requested, in the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid. */ name?: string; @@ -558,7 +558,7 @@ export namespace iamcredentials_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the service account for which the credentials are requested, in the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid. + * Required. The resource name of the service account for which the credentials are requested, in the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid. */ name?: string; @@ -575,7 +575,7 @@ export namespace iamcredentials_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the service account for which the credentials are requested, in the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid. + * Required. The resource name of the service account for which the credentials are requested, in the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid. */ name?: string; @@ -592,7 +592,7 @@ export namespace iamcredentials_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the service account for which the credentials are requested, in the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid. + * Required. The resource name of the service account for which the credentials are requested, in the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid. */ name?: string; diff --git a/src/apis/iap/v1.ts b/src/apis/iap/v1.ts index 8b558322c5e..b629eaf0ff8 100644 --- a/src/apis/iap/v1.ts +++ b/src/apis/iap/v1.ts @@ -103,6 +103,7 @@ export namespace iap_v1 { */ export class Iap { context: APIRequestContext; + oauth: Resource$Oauth; v1: Resource$V1; constructor(options: GlobalOptions, google?: GoogleConfigurable) { @@ -111,6 +112,7 @@ export namespace iap_v1 { google, }; + this.oauth = new Resource$Oauth(this.context); this.v1 = new Resource$V1(this.context); } } @@ -150,7 +152,7 @@ export namespace iap_v1 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -158,6 +160,27 @@ export namespace iap_v1 { */ role?: string | null; } + /** + * OAuth brand data. NOTE: Only contains a portion of the data that describes a brand. + */ + export interface Schema$Brand { + /** + * Application name displayed on OAuth consent screen. + */ + applicationTitle?: string | null; + /** + * Output only. Identifier of the brand. NOTE: GCP project number achieves the same brand identification purpose as only one brand per project can be created. + */ + name?: string | null; + /** + * Output only. Whether the brand is only intended for usage inside the GSuite organization only. + */ + orgInternalOnly?: boolean | null; + /** + * Support email displayed on the OAuth consent screen. + */ + supportEmail?: string | null; + } /** * Allows customers to configure HTTP request paths that'll allow HTTP OPTIONS call to bypass authentication and authorization. */ @@ -176,6 +199,10 @@ export namespace iap_v1 { */ rctokenAud?: string | null; } + /** + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + */ + export interface Schema$Empty {} /** * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ @@ -245,6 +272,45 @@ export namespace iap_v1 { */ name?: string | null; } + /** + * Contains the data that describes an Identity Aware Proxy owned client. + */ + export interface Schema$IdentityAwareProxyClient { + /** + * Human-friendly name given to the OAuth client. + */ + displayName?: string | null; + /** + * Output only. Unique identifier of the OAuth client. + */ + name?: string | null; + /** + * Output only. Client secret of the OAuth client. + */ + secret?: string | null; + } + /** + * Response message for ListBrands. + */ + export interface Schema$ListBrandsResponse { + /** + * Brands existing in the project. + */ + brands?: Schema$Brand[]; + } + /** + * Response message for ListIdentityAwareProxyClients. + */ + export interface Schema$ListIdentityAwareProxyClientsResponse { + /** + * Clients existing in the brand. + */ + identityAwareProxyClients?: Schema$IdentityAwareProxyClient[]; + /** + * A token, which can be send as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } /** * Configuration for OAuth login&consent flow behavior. */ @@ -255,22 +321,26 @@ export namespace iap_v1 { loginHint?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if either of incoming or stored policy does not meet the version requirements. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a conditional binding from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, any version compliance checks on the incoming and/or stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } + /** + * The request sent to ResetIdentityAwareProxyClientSecret. + */ + export interface Schema$ResetIdentityAwareProxyClientSecretRequest {} /** * Request message for `SetIamPolicy` method. */ @@ -299,6 +369,770 @@ export namespace iap_v1 { permissions?: string[] | null; } + export class Resource$Oauth { + context: APIRequestContext; + projects: Resource$Oauth$Projects; + constructor(context: APIRequestContext) { + this.context = context; + this.projects = new Resource$Oauth$Projects(this.context); + } + } + + export class Resource$Oauth$Projects { + context: APIRequestContext; + brands: Resource$Oauth$Projects$Brands; + constructor(context: APIRequestContext) { + this.context = context; + this.brands = new Resource$Oauth$Projects$Brands(this.context); + } + } + + export class Resource$Oauth$Projects$Brands { + context: APIRequestContext; + identityAwareProxyClients: Resource$Oauth$Projects$Brands$Identityawareproxyclients; + constructor(context: APIRequestContext) { + this.context = context; + this.identityAwareProxyClients = new Resource$Oauth$Projects$Brands$Identityawareproxyclients( + this.context + ); + } + + /** + * iap.oauth.projects.brands.create + * @desc Constructs a new OAuth brand for the project if one does not exist. The created brand is "internal only", meaning that OAuth clients created under it only accept requests from users who belong to the same G Suite organization as the project. The brand is created in an un-reviewed status. NOTE: The "internal only" status can be manually changed in the Google Cloud console. Requires that a brand does not already exist for the project, and that the specified support email is owned by the caller. + * @alias iap.oauth.projects.brands.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. GCP Project number/id under which the brand is to be created. In the following format: projects/{project_number/id}. + * @param {().Brand} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params?: Params$Resource$Oauth$Projects$Brands$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Oauth$Projects$Brands$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Oauth$Projects$Brands$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Oauth$Projects$Brands$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Oauth$Projects$Brands$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Oauth$Projects$Brands$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iap.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/oauth/{+parent}/brands').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * iap.oauth.projects.brands.get + * @desc Retrieves the OAuth brand of the project. + * @alias iap.oauth.projects.brands.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. Name of the brand to be fetched. In the following format: projects/{project_number/id}/brands/{brand}. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Oauth$Projects$Brands$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Oauth$Projects$Brands$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Oauth$Projects$Brands$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Oauth$Projects$Brands$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Oauth$Projects$Brands$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Oauth$Projects$Brands$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iap.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/oauth/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * iap.oauth.projects.brands.list + * @desc Lists the existing brands for the project. + * @alias iap.oauth.projects.brands.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. GCP Project number/id. In the following format: projects/{project_number/id}. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Oauth$Projects$Brands$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Oauth$Projects$Brands$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Oauth$Projects$Brands$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Oauth$Projects$Brands$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Oauth$Projects$Brands$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Oauth$Projects$Brands$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iap.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/oauth/{+parent}/brands').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Oauth$Projects$Brands$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. GCP Project number/id under which the brand is to be created. In the following format: projects/{project_number/id}. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Brand; + } + export interface Params$Resource$Oauth$Projects$Brands$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. Name of the brand to be fetched. In the following format: projects/{project_number/id}/brands/{brand}. + */ + name?: string; + } + export interface Params$Resource$Oauth$Projects$Brands$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. GCP Project number/id. In the following format: projects/{project_number/id}. + */ + parent?: string; + } + + export class Resource$Oauth$Projects$Brands$Identityawareproxyclients { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * iap.oauth.projects.brands.identityAwareProxyClients.create + * @desc Creates an Identity Aware Proxy (IAP) OAuth client. The client is owned by IAP. Requires that the brand for the project exists and that it is set for internal-only use. + * @alias iap.oauth.projects.brands.identityAwareProxyClients.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. Path to create the client in. In the following format: projects/{project_number/id}/brands/{brand}. The project must belong to a GSuite account. + * @param {().IdentityAwareProxyClient} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params?: Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iap.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/oauth/{+parent}/identityAwareProxyClients' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * iap.oauth.projects.brands.identityAwareProxyClients.delete + * @desc Deletes an Identity Aware Proxy (IAP) OAuth client. Useful for removing obsolete clients, managing the number of clients in a given project, and cleaning up after tests. Requires that the client is owned by IAP. + * @alias iap.oauth.projects.brands.identityAwareProxyClients.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. Name of the Identity Aware Proxy client to be deleted. In the following format: projects/{project_number/id}/brands/{brand}/identityAwareProxyClients/{client_id}. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iap.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/oauth/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * iap.oauth.projects.brands.identityAwareProxyClients.get + * @desc Retrieves an Identity Aware Proxy (IAP) OAuth client. Requires that the client is owned by IAP. + * @alias iap.oauth.projects.brands.identityAwareProxyClients.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. Name of the Identity Aware Proxy client to be fetched. In the following format: projects/{project_number/id}/brands/{brand}/identityAwareProxyClients/{client_id}. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iap.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/oauth/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * iap.oauth.projects.brands.identityAwareProxyClients.list + * @desc Lists the existing clients for the brand. + * @alias iap.oauth.projects.brands.identityAwareProxyClients.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize The maximum number of clients to return. The service may return fewer than this value. If unspecified, at most 100 clients will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * @param {string=} params.pageToken A page token, received from a previous `ListIdentityAwareProxyClients` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityAwareProxyClients` must match the call that provided the page token. + * @param {string} params.parent Required. Full brand path. In the following format: projects/{project_number/id}/brands/{brand}. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback< + Schema$ListIdentityAwareProxyClientsResponse + > + ): void; + list( + params: Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$List, + callback: BodyResponseCallback< + Schema$ListIdentityAwareProxyClientsResponse + > + ): void; + list( + callback: BodyResponseCallback< + Schema$ListIdentityAwareProxyClientsResponse + > + ): void; + list( + paramsOrCallback?: + | Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$ListIdentityAwareProxyClientsResponse + > + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iap.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/oauth/{+parent}/identityAwareProxyClients' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * iap.oauth.projects.brands.identityAwareProxyClients.resetSecret + * @desc Resets an Identity Aware Proxy (IAP) OAuth client secret. Useful if the secret was compromised. Requires that the client is owned by IAP. + * @alias iap.oauth.projects.brands.identityAwareProxyClients.resetSecret + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. Name of the Identity Aware Proxy client to that will have its secret reset. In the following format: projects/{project_number/id}/brands/{brand}/identityAwareProxyClients/{client_id}. + * @param {().ResetIdentityAwareProxyClientSecretRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + resetSecret( + params?: Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Resetsecret, + options?: MethodOptions + ): GaxiosPromise; + resetSecret( + params: Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Resetsecret, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resetSecret( + params: Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Resetsecret, + callback: BodyResponseCallback + ): void; + resetSecret( + callback: BodyResponseCallback + ): void; + resetSecret( + paramsOrCallback?: + | Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Resetsecret + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Resetsecret; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Resetsecret; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iap.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/oauth/{+name}:resetSecret').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. Path to create the client in. In the following format: projects/{project_number/id}/brands/{brand}. The project must belong to a GSuite account. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$IdentityAwareProxyClient; + } + export interface Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. Name of the Identity Aware Proxy client to be deleted. In the following format: projects/{project_number/id}/brands/{brand}/identityAwareProxyClients/{client_id}. + */ + name?: string; + } + export interface Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. Name of the Identity Aware Proxy client to be fetched. In the following format: projects/{project_number/id}/brands/{brand}/identityAwareProxyClients/{client_id}. + */ + name?: string; + } + export interface Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The maximum number of clients to return. The service may return fewer than this value. If unspecified, at most 100 clients will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListIdentityAwareProxyClients` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityAwareProxyClients` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. Full brand path. In the following format: projects/{project_number/id}/brands/{brand}. + */ + parent?: string; + } + export interface Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Resetsecret + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. Name of the Identity Aware Proxy client to that will have its secret reset. In the following format: projects/{project_number/id}/brands/{brand}/identityAwareProxyClients/{client_id}. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ResetIdentityAwareProxyClientSecretRequest; + } + export class Resource$V1 { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/iap/v1beta1.ts b/src/apis/iap/v1beta1.ts index 29d606ebbf6..ac74aa1178f 100644 --- a/src/apis/iap/v1beta1.ts +++ b/src/apis/iap/v1beta1.ts @@ -124,7 +124,7 @@ export namespace iap_v1beta1 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -172,19 +172,19 @@ export namespace iap_v1beta1 { requestedPolicyVersion?: number | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if either of incoming or stored policy does not meet the version requirements. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a conditional binding from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, any version compliance checks on the incoming and/or stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } diff --git a/src/apis/index.ts b/src/apis/index.ts index 71ec903500a..c2a79f059cf 100644 --- a/src/apis/index.ts +++ b/src/apis/index.ts @@ -97,7 +97,6 @@ import * as firebasehosting from './firebasehosting'; import * as firebaserules from './firebaserules'; import * as firestore from './firestore'; import * as fitness from './fitness'; -import * as fusiontables from './fusiontables'; import * as games from './games'; import * as gamesConfiguration from './gamesConfiguration'; import * as gamesManagement from './gamesManagement'; @@ -132,6 +131,7 @@ import * as plus from './plus'; import * as plusDomains from './plusDomains'; import * as policytroubleshooter from './policytroubleshooter'; import * as poly from './poly'; +import * as prod_tt_sasportal from './prod_tt_sasportal'; import * as proximitybeacon from './proximitybeacon'; import * as pubsub from './pubsub'; import * as recommender from './recommender'; @@ -142,8 +142,9 @@ import * as reseller from './reseller'; import * as run from './run'; import * as runtimeconfig from './runtimeconfig'; import * as safebrowsing from './safebrowsing'; +import * as sasportal from './sasportal'; import * as script from './script'; -import * as searchconsole from './searchconsole'; +import * as secretmanager from './secretmanager'; import * as securitycenter from './securitycenter'; import * as servicebroker from './servicebroker'; import * as serviceconsumermanagement from './serviceconsumermanagement'; @@ -161,7 +162,6 @@ import * as sql from './sql'; import * as storage from './storage'; import * as storagetransfer from './storagetransfer'; import * as streetviewpublish from './streetviewpublish'; -import * as surveys from './surveys'; import * as tagmanager from './tagmanager'; import * as tasks from './tasks'; import * as testing from './testing'; @@ -270,7 +270,6 @@ export const APIS: APIList = { firebaserules: firebaserules.VERSIONS, firestore: firestore.VERSIONS, fitness: fitness.VERSIONS, - fusiontables: fusiontables.VERSIONS, games: games.VERSIONS, gamesConfiguration: gamesConfiguration.VERSIONS, gamesManagement: gamesManagement.VERSIONS, @@ -305,6 +304,7 @@ export const APIS: APIList = { plusDomains: plusDomains.VERSIONS, policytroubleshooter: policytroubleshooter.VERSIONS, poly: poly.VERSIONS, + prod_tt_sasportal: prod_tt_sasportal.VERSIONS, proximitybeacon: proximitybeacon.VERSIONS, pubsub: pubsub.VERSIONS, recommender: recommender.VERSIONS, @@ -315,8 +315,9 @@ export const APIS: APIList = { run: run.VERSIONS, runtimeconfig: runtimeconfig.VERSIONS, safebrowsing: safebrowsing.VERSIONS, + sasportal: sasportal.VERSIONS, script: script.VERSIONS, - searchconsole: searchconsole.VERSIONS, + secretmanager: secretmanager.VERSIONS, securitycenter: securitycenter.VERSIONS, servicebroker: servicebroker.VERSIONS, serviceconsumermanagement: serviceconsumermanagement.VERSIONS, @@ -334,7 +335,6 @@ export const APIS: APIList = { storage: storage.VERSIONS, storagetransfer: storagetransfer.VERSIONS, streetviewpublish: streetviewpublish.VERSIONS, - surveys: surveys.VERSIONS, tagmanager: tagmanager.VERSIONS, tasks: tasks.VERSIONS, testing: testing.VERSIONS, @@ -441,7 +441,6 @@ export class GeneratedAPIs { firebaserules = firebaserules.firebaserules; firestore = firestore.firestore; fitness = fitness.fitness; - fusiontables = fusiontables.fusiontables; games = games.games; gamesConfiguration = gamesConfiguration.gamesConfiguration; gamesManagement = gamesManagement.gamesManagement; @@ -476,6 +475,7 @@ export class GeneratedAPIs { plusDomains = plusDomains.plusDomains; policytroubleshooter = policytroubleshooter.policytroubleshooter; poly = poly.poly; + prod_tt_sasportal = prod_tt_sasportal.prod_tt_sasportal; proximitybeacon = proximitybeacon.proximitybeacon; pubsub = pubsub.pubsub; recommender = recommender.recommender; @@ -486,8 +486,9 @@ export class GeneratedAPIs { run = run.run; runtimeconfig = runtimeconfig.runtimeconfig; safebrowsing = safebrowsing.safebrowsing; + sasportal = sasportal.sasportal; script = script.script; - searchconsole = searchconsole.searchconsole; + secretmanager = secretmanager.secretmanager; securitycenter = securitycenter.securitycenter; servicebroker = servicebroker.servicebroker; serviceconsumermanagement = @@ -506,7 +507,6 @@ export class GeneratedAPIs { storage = storage.storage; storagetransfer = storagetransfer.storagetransfer; streetviewpublish = streetviewpublish.streetviewpublish; - surveys = surveys.surveys; tagmanager = tagmanager.tagmanager; tasks = tasks.tasks; testing = testing.testing; diff --git a/src/apis/language/v1beta2.ts b/src/apis/language/v1beta2.ts index c155639209c..29f59a63c98 100644 --- a/src/apis/language/v1beta2.ts +++ b/src/apis/language/v1beta2.ts @@ -321,6 +321,10 @@ export namespace language_v1beta2 { * ################################################################ # Represents the input to API methods. */ export interface Schema$Document { + /** + * Indicates how detected boilerplate(e.g. advertisements, copyright declarations, banners) should be handled for this document. If not specified, boilerplate will be treated the same as content. + */ + boilerplateHandling?: string | null; /** * The content of the input in string format. Cloud audit logging exempt since it is based on user data. */ @@ -333,6 +337,10 @@ export namespace language_v1beta2 { * The language of the document (if not specified, the language is automatically detected). Both ISO and BCP-47 language codes are accepted.<br> [Language Support](/natural-language/docs/languages) lists currently supported languages for each API method. If the language (either specified by the caller or automatically detected) is not supported by the called API method, an `INVALID_ARGUMENT` error is returned. */ language?: string | null; + /** + * The web URI where the document comes from. This URI is not used for fetching the content, but as a hint for analyzing the document. + */ + referenceWebUri?: string | null; /** * Required. If the type is not set or is `TYPE_UNSPECIFIED`, returns an `INVALID_ARGUMENT` error. */ diff --git a/src/apis/logging/README.md b/src/apis/logging/README.md index 914d7118269..e24c1b9f502 100644 --- a/src/apis/logging/README.md +++ b/src/apis/logging/README.md @@ -2,7 +2,7 @@ # logging -> Writes log entries and manages your Stackdriver Logging configuration. The table entries below are presented in alphabetical order, not in order of common use. For explanations of the concepts found in the table entries, read the [Stackdriver Logging documentation](/logging/docs). +> Writes log entries and manages your Stackdriver Logging configuration. The table entries below are presented in alphabetical order, not in order of common use. For explanations of the concepts found in the table entries, read the Stackdriver Logging documentation <https://cloud.google.com/logging/docs>. ## Installation diff --git a/src/apis/logging/v2.ts b/src/apis/logging/v2.ts index a69b3e908a6..c8855763710 100644 --- a/src/apis/logging/v2.ts +++ b/src/apis/logging/v2.ts @@ -89,7 +89,7 @@ export namespace logging_v2 { /** * Stackdriver Logging API * - * Writes log entries and manages your Stackdriver Logging configuration. The table entries below are presented in alphabetical order, not in order of common use. For explanations of the concepts found in the table entries, read the Stackdriver Logging documentation. + * Writes log entries and manages your Stackdriver Logging configuration. The table entries below are presented in alphabetical order, not in order of common use. For explanations of the concepts found in the table entries, read the <a href=https://cloud.google.com/logging/docs>Stackdriver Logging documentation</a>. * * @example * const {google} = require('googleapis'); @@ -699,7 +699,7 @@ export namespace logging_v2 { */ type?: string | null; /** - * The unit in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are a subset of The Unified Code for Units of Measure (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit By byte s second min minute h hour d dayPrefixes (PREFIX) k kilo (10**3) M mega (10**6) G giga (10**9) T tera (10**12) P peta (10**15) E exa (10**18) Z zetta (10**21) Y yotta (10**24) m milli (10**-3) u micro (10**-6) n nano (10**-9) p pico (10**-12) f femto (10**-15) a atto (10**-18) z zepto (10**-21) y yocto (10**-24) Ki kibi (2**10) Mi mebi (2**20) Gi gibi (2**30) Ti tebi (2**40)GrammarThe grammar also includes these connectors: / division (as an infix operator, e.g. 1/s). . multiplication (as an infix operator, e.g. GBy.d)The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: Annotation is just a comment if it follows a UNIT and is equivalent to 1 if it is used alone. For examples, {requests}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of non-blank printable ASCII characters not containing '{' or '}'. 1 represents dimensionless value 1, such as in 1/s. % represents dimensionless value 1/100, and annotates values giving a percentage. + * Ki kibi (2^10) Mi mebi (2^20) Gi gibi (2^30) Ti tebi (2^40) Pi pebi (2^50)GrammarThe grammar also includes these connectors: / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h.The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of non-blank printable ASCII characters not containing { or }. 1 represents a unitary dimensionless unit (https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent"). */ unit?: string | null; /** diff --git a/src/apis/ml/v1.ts b/src/apis/ml/v1.ts index 5c7d2dd7049..1719cdb99db 100644 --- a/src/apis/ml/v1.ts +++ b/src/apis/ml/v1.ts @@ -215,7 +215,7 @@ export namespace ml_v1 { httpBody?: Schema$GoogleApi__HttpBody; } /** - * Message holding configuration options for explaining model predictions. Currently, the only supported mechanism to explain a model's prediction is through attributing its output back to its inputs which is essentially a credit assignment task. We support multiple attribution methods, some specific to particular frameworks like Tensorflow and XGBoost. Next idx: 7. + * Message holding configuration options for explaining model predictions. There are two feature attribution methods supported for TensorFlow models: integrated gradients and sampled Shapley. <a href="/ml-engine/docs/ai-explanations/overview">Learn more about feature attributions</a>. */ export interface Schema$GoogleCloudMlV1__ExplanationConfig { integratedGradientsAttribution?: Schema$GoogleCloudMlV1__IntegratedGradientsAttribution; @@ -449,7 +449,7 @@ export namespace ml_v1 { */ export interface Schema$GoogleCloudMlV1__Model { /** - * Output only. The default version of the model. This version will be used to handle prediction requests that do not specify a version. You can change the default version by calling [projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault). + * Output only. The default version of the model. This version will be used to handle prediction requests that do not specify a version. You can change the default version by calling projects.models.versions.setDefault. */ defaultVersion?: Schema$GoogleCloudMlV1__Version; /** @@ -634,7 +634,7 @@ export namespace ml_v1 { */ export interface Schema$GoogleCloudMlV1__PredictRequest { /** - * Required. The prediction request body. + * Required. The prediction request body. Refer to the [request body details section](#request-body-details) for more information on how to structure your request. */ httpBody?: Schema$GoogleApi__HttpBody; } @@ -673,7 +673,7 @@ export namespace ml_v1 { */ export interface Schema$GoogleCloudMlV1__SampledShapleyAttribution { /** - * The number of feature permutations to consider when approximating the shapley values. + * The number of feature permutations to consider when approximating the Shapley values. */ numPaths?: number | null; } @@ -726,7 +726,7 @@ export namespace ml_v1 { */ pythonModule?: string | null; /** - * Optional. The version of Python used in training. If not set, the default version is '2.7'. Python '3.5' is available when `runtime_version` is set to '1.4' and above. Python '2.7' works with all supported <a href="/ml-engine/docs/runtime-version-list">runtime versions</a>. + * Optional. The version of Python used in training. If not set, the default version is '2.7'. Starting [January 13, 2020](/ml-engine/docs/release-notes#december_10_2019), this field is required. The following Python versions are available: * Python '3.7' is available when `runtime_version` is set to '1.15' or later. * Python '3.5' is available when `runtime_version` is set to a version from '1.4' to '1.14'. * Python '2.7' is available when `runtime_version` is set to '1.15' or earlier. (Runtime versions released [after January 1, 2020](/ml-engine/docs/release-notes#december_10_2019) do not support Python 2.7.) Read more about the Python versions available for [each runtime version](/ml-engine/docs/runtime-version-list). */ pythonVersion?: string | null; /** @@ -734,7 +734,7 @@ export namespace ml_v1 { */ region?: string | null; /** - * Optional. The AI Platform runtime version to use for training. If not set, AI Platform uses the default stable version, 1.0. For more information, see the <a href="/ml-engine/docs/runtime-version-list">runtime version list</a> and <a href="/ml-engine/docs/versioning">how to manage runtime versions</a>. + * Optional. The AI Platform runtime version to use for training. If not set, AI Platform uses the default stable version, 1.0. Starting [January 13, 2020](/ml-engine/docs/release-notes#december_10_2019), this field is required. For more information, see the <a href="/ml-engine/docs/runtime-version-list">runtime version list</a> and <a href="/ml-engine/docs/versioning">how to manage runtime versions</a>. */ runtimeVersion?: string | null; /** @@ -792,7 +792,7 @@ export namespace ml_v1 { trials?: Schema$GoogleCloudMlV1__HyperparameterOutput[]; } /** - * Represents a version of the model. Each version is a trained model deployed in the cloud, ready to handle prediction requests. A model can have multiple versions. You can get information about all of the versions of a given model by calling [projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list). + * Represents a version of the model. Each version is a trained model deployed in the cloud, ready to handle prediction requests. A model can have multiple versions. You can get information about all of the versions of a given model by calling projects.models.versions.list. */ export interface Schema$GoogleCloudMlV1__Version { /** @@ -808,7 +808,7 @@ export namespace ml_v1 { */ createTime?: string | null; /** - * Required. The Cloud Storage location of the trained model used to create the version. See the [guide to model deployment](/ml-engine/docs/tensorflow/deploying-models) for more information. When passing Version to [projects.models.versions.create](/ml-engine/reference/rest/v1/projects.models.versions/create) the model service uses the specified location as the source of the model. Once deployed, the model version is hosted by the prediction service, so this location is useful only as a historical record. The total number of model files can't exceed 1000. + * Required. The Cloud Storage location of the trained model used to create the version. See the [guide to model deployment](/ml-engine/docs/tensorflow/deploying-models) for more information. When passing Version to projects.models.versions.create the model service uses the specified location as the source of the model. Once deployed, the model version is hosted by the prediction service, so this location is useful only as a historical record. The total number of model files can't exceed 1000. */ deploymentUri?: string | null; /** @@ -832,7 +832,7 @@ export namespace ml_v1 { */ framework?: string | null; /** - * Output only. If true, this version will be used to handle prediction requests that do not specify a version. You can change the default version by calling [projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault). + * Output only. If true, this version will be used to handle prediction requests that do not specify a version. You can change the default version by calling projects.methods.versions.setDefault. */ isDefault?: boolean | null; /** @@ -864,15 +864,15 @@ export namespace ml_v1 { */ predictionClass?: string | null; /** - * Optional. The version of Python used in prediction. If not set, the default version is '2.7'. Python '3.5' is available when `runtime_version` is set to '1.4' and above. Python '2.7' works with all supported runtime versions. + * Optional. The version of Python used in prediction. If not set, the default version is '2.7'. Starting [January 13, 2020](/ml-engine/docs/release-notes#december_10_2019), this field is required. The following Python versions are available: * Python '3.7' is available when `runtime_version` is set to '1.15' or later. * Python '3.5' is available when `runtime_version` is set to a version from '1.4' to '1.14'. * Python '2.7' is available when `runtime_version` is set to '1.15' or earlier. (Runtime versions released [after January 1, 2020](/ml-engine/docs/release-notes#december_10_2019) do not support Python 2.7.) Read more about the Python versions available for [each runtime version](/ml-engine/docs/runtime-version-list). */ pythonVersion?: string | null; /** - * Optional. Configures the request-response pair logging on predictions from this Version. + * Optional. *Only* specify this field in a projects.models.versions.patch request. Specifying it in a projects.models.versions.create request has no effect. Configures the request-response pair logging on predictions from this Version. */ requestLoggingConfig?: Schema$GoogleCloudMlV1__RequestLoggingConfig; /** - * Optional. The AI Platform runtime version to use for this deployment. If not set, AI Platform uses the default stable version, 1.0. For more information, see the [runtime version list](/ml-engine/docs/runtime-version-list) and [how to manage runtime versions](/ml-engine/docs/versioning). + * Optional. The AI Platform runtime version to use for this deployment. If not set, AI Platform uses the default stable version, 1.0. Starting [January 13, 2020](/ml-engine/docs/release-notes#december_10_2019), this field is required. For more information, see the [runtime version list](/ml-engine/docs/runtime-version-list) and [how to manage runtime versions](/ml-engine/docs/versioning). */ runtimeVersion?: string | null; /** @@ -919,7 +919,7 @@ export namespace ml_v1 { */ condition?: Schema$GoogleType__Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -928,7 +928,7 @@ export namespace ml_v1 { role?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$GoogleIamV1__Policy { /** @@ -936,15 +936,15 @@ export namespace ml_v1 { */ auditConfigs?: Schema$GoogleIamV1__AuditConfig[]; /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$GoogleIamV1__Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if the incoming policy version does not meet the requirements for modifying the stored policy. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a binding (conditional or unconditional) from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, version compliance checks against the stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } @@ -1076,7 +1076,7 @@ export namespace ml_v1 { /** * ml.projects.explain - * @desc Performs explanation on the data in the request. AI Platform implements a custom `explain` verb on top of an HTTP POST method.

For details of the request and response format, see the **guide to the [explain request format](/ml-engine/docs/v1/explain-request)**. + * @desc Performs explanation on the data in the request. AI Platform implements a custom `explain` verb on top of an HTTP POST method. * @alias ml.projects.explain * @memberOf! () * @@ -1233,7 +1233,7 @@ export namespace ml_v1 { /** * ml.projects.predict - * @desc Performs prediction on the data in the request. AI Platform implements a custom `predict` verb on top of an HTTP POST method.

For details of the request and response format, see the **guide to the [predict request format](/ml-engine/docs/v1/predict-request)**. + * @desc Performs online prediction on the data in the request.

{% dynamic include "/ai-platform/includes/___predict-request" %}
* @alias ml.projects.predict * @memberOf! () * @@ -2344,7 +2344,7 @@ export namespace ml_v1 { /** * ml.projects.models.create - * @desc Creates a model which will later contain one or more versions. You must add at least one version before you can request predictions from the model. Add versions by calling [projects.models.versions.create](/ml-engine/reference/rest/v1/projects.models.versions/create). + * @desc Creates a model which will later contain one or more versions. You must add at least one version before you can request predictions from the model. Add versions by calling projects.models.versions.create. * @alias ml.projects.models.create * @memberOf! () * @@ -2421,7 +2421,7 @@ export namespace ml_v1 { /** * ml.projects.models.delete - * @desc Deletes a model. You can only delete a model if there are no versions in it. You can delete versions by calling [projects.models.versions.delete](/ml-engine/reference/rest/v1/projects.models.versions/delete). + * @desc Deletes a model. You can only delete a model if there are no versions in it. You can delete versions by calling projects.models.versions.delete. * @alias ml.projects.models.delete * @memberOf! () * @@ -3134,7 +3134,7 @@ export namespace ml_v1 { /** * ml.projects.models.versions.create - * @desc Creates a new version of a model from a trained TensorFlow model. If the version created in the cloud by this call is the first deployed version of the specified model, it will be made the default version of the model. When you add a version to a model that already has one or more versions, the default version does not automatically change. If you want a new version to be the default, you must call [projects.models.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault). + * @desc Creates a new version of a model from a trained TensorFlow model. If the version created in the cloud by this call is the first deployed version of the specified model, it will be made the default version of the model. When you add a version to a model that already has one or more versions, the default version does not automatically change. If you want a new version to be the default, you must call projects.models.versions.setDefault. * @alias ml.projects.models.versions.create * @memberOf! () * @@ -3223,7 +3223,7 @@ export namespace ml_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The name of the version. You can get the names of all the versions of a model by calling [projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list). + * @param {string} params.name Required. The name of the version. You can get the names of all the versions of a model by calling projects.models.versions.list. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3298,7 +3298,7 @@ export namespace ml_v1 { /** * ml.projects.models.versions.get - * @desc Gets information about a model version. Models can have multiple versions. You can call [projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list) to get the same information that this method returns for all of the versions of a model. + * @desc Gets information about a model version. Models can have multiple versions. You can call projects.models.versions.list to get the same information that this method returns for all of the versions of a model. * @alias ml.projects.models.versions.get * @memberOf! () * @@ -3465,13 +3465,13 @@ export namespace ml_v1 { /** * ml.projects.models.versions.patch - * @desc Updates the specified Version resource. Currently the only update-able fields are `description` and `autoScaling.minNodes`. + * @desc Updates the specified Version resource. Currently the only update-able fields are `description`, `requestLoggingConfig`, `autoScaling.minNodes`, and `manualScaling.nodes`. * @alias ml.projects.models.versions.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name Required. The name of the model. - * @param {string=} params.updateMask Required. Specifies the path, relative to `Version`, of the field to update. Must be present and non-empty. For example, to change the description of a version to "foo", the `update_mask` parameter would be specified as `description`, and the `PATCH` request body would specify the new value, as follows: ``` { "description": "foo" } ``` Currently the only supported update mask fields are `description`, `autoScaling.minNodes`, and `manualScaling.nodes`. However, you can only update `manualScaling.nodes` if the version uses a [Compute Engine (N1) machine type](/ml-engine/docs/machine-types-online-prediction). + * @param {string=} params.updateMask Required. Specifies the path, relative to `Version`, of the field to update. Must be present and non-empty. For example, to change the description of a version to "foo", the `update_mask` parameter would be specified as `description`, and the `PATCH` request body would specify the new value, as follows: ``` { "description": "foo" } ``` Currently the only supported update mask fields are `description`, `requestLoggingConfig`, `autoScaling.minNodes`, and `manualScaling.nodes`. However, you can only update `manualScaling.nodes` if the version uses a [Compute Engine (N1) machine type](/ml-engine/docs/machine-types-online-prediction). * @param {().GoogleCloudMlV1__Version} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3552,7 +3552,7 @@ export namespace ml_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The name of the version to make the default for the model. You can get the names of all the versions of a model by calling [projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list). + * @param {string} params.name Required. The name of the version to make the default for the model. You can get the names of all the versions of a model by calling projects.models.versions.list. * @param {().GoogleCloudMlV1__SetDefaultVersionRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3650,7 +3650,7 @@ export namespace ml_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the version. You can get the names of all the versions of a model by calling [projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list). + * Required. The name of the version. You can get the names of all the versions of a model by calling projects.models.versions.list. */ name?: string; } @@ -3702,7 +3702,7 @@ export namespace ml_v1 { */ name?: string; /** - * Required. Specifies the path, relative to `Version`, of the field to update. Must be present and non-empty. For example, to change the description of a version to "foo", the `update_mask` parameter would be specified as `description`, and the `PATCH` request body would specify the new value, as follows: ``` { "description": "foo" } ``` Currently the only supported update mask fields are `description`, `autoScaling.minNodes`, and `manualScaling.nodes`. However, you can only update `manualScaling.nodes` if the version uses a [Compute Engine (N1) machine type](/ml-engine/docs/machine-types-online-prediction). + * Required. Specifies the path, relative to `Version`, of the field to update. Must be present and non-empty. For example, to change the description of a version to "foo", the `update_mask` parameter would be specified as `description`, and the `PATCH` request body would specify the new value, as follows: ``` { "description": "foo" } ``` Currently the only supported update mask fields are `description`, `requestLoggingConfig`, `autoScaling.minNodes`, and `manualScaling.nodes`. However, you can only update `manualScaling.nodes` if the version uses a [Compute Engine (N1) machine type](/ml-engine/docs/machine-types-online-prediction). */ updateMask?: string; @@ -3719,7 +3719,7 @@ export namespace ml_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the version to make the default for the model. You can get the names of all the versions of a model by calling [projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list). + * Required. The name of the version to make the default for the model. You can get the names of all the versions of a model by calling projects.models.versions.list. */ name?: string; diff --git a/src/apis/monitoring/v1.ts b/src/apis/monitoring/v1.ts index d98a01b221a..56960d38ead 100644 --- a/src/apis/monitoring/v1.ts +++ b/src/apis/monitoring/v1.ts @@ -103,15 +103,133 @@ export namespace monitoring_v1 { */ export class Monitoring { context: APIRequestContext; + projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { this.context = { _options: options || {}, google, }; + + this.projects = new Resource$Projects(this.context); } } + /** + * Describes how to combine multiple time series to provide different views of the data. Aggregation consists of an alignment step on individual time series (alignment_period and per_series_aligner) followed by an optional reduction step of the data across the aligned time series (cross_series_reducer and group_by_fields). For more details, see Aggregation. + */ + export interface Schema$Aggregation { + /** + * The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned. + */ + alignmentPeriod?: string | null; + /** + * The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. + */ + crossSeriesReducer?: string | null; + /** + * The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored. + */ + groupByFields?: string[] | null; + /** + * The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. + */ + perSeriesAligner?: string | null; + } + /** + * A chart axis. + */ + export interface Schema$Axis { + /** + * The label of the axis. + */ + label?: string | null; + /** + * The axis scale. By default, a linear scale is used. + */ + scale?: string | null; + } + /** + * Options to control visual rendering of a chart. + */ + export interface Schema$ChartOptions { + /** + * The chart mode. + */ + mode?: string | null; + } + /** + * Defines the layout properties and content for a column. + */ + export interface Schema$Column { + /** + * The relative weight of this column. The column weight is used to adjust the width of columns on the screen (relative to peers). Greater the weight, greater the width of the column on the screen. If omitted, a value of 1 is used while rendering. + */ + weight?: string | null; + /** + * The display widgets arranged vertically in this column. + */ + widgets?: Schema$Widget[]; + } + /** + * A simplified layout that divides the available space into vertical columns and arranges a set of widgets vertically in each column. + */ + export interface Schema$ColumnLayout { + /** + * The columns of content to display. + */ + columns?: Schema$Column[]; + } + /** + * A Google Stackdriver dashboard. Dashboards define the content and layout of pages in the Stackdriver web application. + */ + export interface Schema$Dashboard { + /** + * The content is divided into equally spaced columns and the widgets are arranged vertically. + */ + columnLayout?: Schema$ColumnLayout; + /** + * The mutable, human-readable name. + */ + displayName?: string | null; + /** + * etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. An etag is returned in the response to GetDashboard, and users are expected to put that etag in the request to UpdateDashboard to ensure that their change will be applied to the same version of the Dashboard configuration. The field should not be passed during dashboard creation. + */ + etag?: string | null; + /** + * Content is arranged with a basic layout that re-flows a simple list of informational elements like widgets or tiles. + */ + gridLayout?: Schema$GridLayout; + /** + * The resource name of the dashboard. + */ + name?: string | null; + /** + * The content is divided into equally spaced rows and the widgets are arranged horizontally. + */ + rowLayout?: Schema$RowLayout; + } + /** + * Groups a time series query definition with charting options. + */ + export interface Schema$DataSet { + /** + * A template string for naming TimeSeries in the resulting data set. This should be a string with interpolations of the form ${label_name}, which will resolve to the label's value. + */ + legendTemplate?: string | null; + /** + * Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals. + */ + minAlignmentPeriod?: string | null; + /** + * How this data should be plotted on the chart. + */ + plotType?: string | null; + /** + * Fields for querying time series data from the Stackdriver metrics API. + */ + timeSeriesQuery?: Schema$TimeSeriesQuery; + } /** * A set of (label, value) pairs which were dropped during aggregation, attached to google.api.Distribution.Exemplars in google.api.Distribution values during aggregation.These values are used in combination with the label values that remain on the aggregated Distribution timeseries to construct the full label set for the exemplar values. The resulting full label set may be used to identify the specific task/job/instance (for example) which may be contributing to a long-tail, while allowing the storage savings of only storing aggregated distribution values for a large group.Note that there are no guarantees on ordering of the labels from exemplar-to-exemplar and from distribution-to-distribution in the same stream, and there may be duplicates. It is up to clients to resolve any ambiguities. */ @@ -121,6 +239,10 @@ export namespace monitoring_v1 { */ label?: {[key: string]: string} | null; } + /** + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}. + */ + export interface Schema$Empty {} /** * A single field of a message type. */ @@ -166,6 +288,45 @@ export namespace monitoring_v1 { */ typeUrl?: string | null; } + /** + * A gauge chart shows where the current value sits within a pre-defined range. The upper and lower bounds should define the possible range of values for the scorecard's query (inclusive). + */ + export interface Schema$GaugeView { + /** + * The lower bound for this gauge chart. The value of the chart should always be greater than or equal to this. + */ + lowerBound?: number | null; + /** + * The upper bound for this gauge chart. The value of the chart should always be less than or equal to this. + */ + upperBound?: number | null; + } + /** + * A basic layout divides the available space into vertical columns of equal width and arranges a list of widgets using a row-first strategy. + */ + export interface Schema$GridLayout { + /** + * The number of columns into which the view's width is divided. If omitted or set to zero, a system default will be used while rendering. + */ + columns?: string | null; + /** + * The informational elements that are arranged into the columns row-first. + */ + widgets?: Schema$Widget[]; + } + /** + * The ListDashboards request. + */ + export interface Schema$ListDashboardsResponse { + /** + * The list of requested dashboards. + */ + dashboards?: Schema$Dashboard[]; + /** + * If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method. + */ + nextPageToken?: string | null; + } /** * A protocol buffer option, which can be attached to a message, field, enumeration, etc. */ @@ -179,6 +340,79 @@ export namespace monitoring_v1 { */ value?: {[key: string]: any} | null; } + /** + * Describes a ranking-based time series filter. Each input time series is ranked with an aligner. The filter lets through up to num_time_series time series, selecting them based on the relative ranking. + */ + export interface Schema$PickTimeSeriesFilter { + /** + * How to use the ranking to select time series that pass through the filter. + */ + direction?: string | null; + /** + * How many time series to return. + */ + numTimeSeries?: number | null; + /** + * rankingMethod is applied to each time series independently to produce the value which will be used to compare the time series to other time series. + */ + rankingMethod?: string | null; + } + /** + * Describes a query to build the numerator or denominator of a TimeSeriesFilterRatio. + */ + export interface Schema$RatioPart { + /** + * By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data. + */ + aggregation?: Schema$Aggregation; + /** + * Required. The monitoring filter that identifies the metric types, resources, and projects to query. + */ + filter?: string | null; + } + /** + * Defines the layout properties and content for a row. + */ + export interface Schema$Row { + /** + * The relative weight of this row. The row weight is used to adjust the height of rows on the screen (relative to peers). Greater the weight, greater the height of the row on the screen. If omitted, a value of 1 is used while rendering. + */ + weight?: string | null; + /** + * The display widgets arranged horizontally in this row. + */ + widgets?: Schema$Widget[]; + } + /** + * A simplified layout that divides the available space into rows and arranges a set of widgets horizontally in each row. + */ + export interface Schema$RowLayout { + /** + * The rows of content to display. + */ + rows?: Schema$Row[]; + } + /** + * A widget showing the latest value of a metric, and how this value relates to one or more thresholds. + */ + export interface Schema$Scorecard { + /** + * Will cause the scorecard to show a gauge chart. + */ + gaugeView?: Schema$GaugeView; + /** + * Will cause the scorecard to show a spark chart. + */ + sparkChartView?: Schema$SparkChartView; + /** + * The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.)As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', }Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state. + */ + thresholds?: Schema$Threshold[]; + /** + * Fields for querying time series data from the Stackdriver metrics API. + */ + timeSeriesQuery?: Schema$TimeSeriesQuery; + } /** * SourceContext represents information about the source of a protobuf element, like the file in which it is defined. */ @@ -197,6 +431,129 @@ export namespace monitoring_v1 { */ spanName?: string | null; } + /** + * A sparkChart is a small chart suitable for inclusion in a table-cell or inline in text. This message contains the configuration for a sparkChart to show up on a Scorecard, showing recent trends of the scorecard's timeseries. + */ + export interface Schema$SparkChartView { + /** + * The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint. + */ + minAlignmentPeriod?: string | null; + /** + * The type of sparkchart to show in this chartView. + */ + sparkChartType?: string | null; + } + /** + * A filter that ranks streams based on their statistical relation to other streams in a request. + */ + export interface Schema$StatisticalTimeSeriesFilter { + /** + * How many time series to output. + */ + numTimeSeries?: number | null; + /** + * rankingMethod is applied to a set of time series, and then the produced value for each individual time series is used to compare a given time series to others. These are methods that cannot be applied stream-by-stream, but rather require the full context of a request to evaluate time series. + */ + rankingMethod?: string | null; + } + /** + * A widget that displays textual content. + */ + export interface Schema$Text { + /** + * The text content to be displayed. + */ + content?: string | null; + /** + * How the text content is formatted. + */ + format?: string | null; + } + /** + * Defines a threshold for categorizing time series values. + */ + export interface Schema$Threshold { + /** + * The state color for this threshold. Color is not allowed in a XyChart. + */ + color?: string | null; + /** + * The direction for the current threshold. Direction is not allowed in a XyChart. + */ + direction?: string | null; + /** + * A label for the threshold. + */ + label?: string | null; + /** + * The value of the threshold. The value should be defined in the native scale of the metric. + */ + value?: number | null; + } + /** + * A filter that defines a subset of time series data that is displayed in a widget. Time series data is fetched using the ListTimeSeries method. + */ + export interface Schema$TimeSeriesFilter { + /** + * By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data. + */ + aggregation?: Schema$Aggregation; + /** + * Required. The monitoring filter that identifies the metric types, resources, and projects to query. + */ + filter?: string | null; + /** + * Ranking based time series filter. + */ + pickTimeSeriesFilter?: Schema$PickTimeSeriesFilter; + /** + * Statistics based time series filter. + */ + statisticalTimeSeriesFilter?: Schema$StatisticalTimeSeriesFilter; + } + /** + * A pair of time series filters that define a ratio computation. The output time series is the pair-wise division of each aligned element from the numerator and denominator time series. + */ + export interface Schema$TimeSeriesFilterRatio { + /** + * The denominator of the ratio. + */ + denominator?: Schema$RatioPart; + /** + * The numerator of the ratio. + */ + numerator?: Schema$RatioPart; + /** + * Ranking based time series filter. + */ + pickTimeSeriesFilter?: Schema$PickTimeSeriesFilter; + /** + * Apply a second aggregation after the ratio is computed. + */ + secondaryAggregation?: Schema$Aggregation; + /** + * Statistics based time series filter. + */ + statisticalTimeSeriesFilter?: Schema$StatisticalTimeSeriesFilter; + } + /** + * TimeSeriesQuery collects the set of supported methods for querying time series data from the Stackdriver metrics API. + */ + export interface Schema$TimeSeriesQuery { + /** + * Filter parameters to fetch time series. + */ + timeSeriesFilter?: Schema$TimeSeriesFilter; + /** + * Parameters to fetch a ratio between two time series filters. + */ + timeSeriesFilterRatio?: Schema$TimeSeriesFilterRatio; + /** + * The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit field in MetricDescriptor. + */ + unitOverride?: string | null; + } /** * A protocol buffer message type. */ @@ -226,4 +583,518 @@ export namespace monitoring_v1 { */ syntax?: string | null; } + /** + * Widget contains a single dashboard component and configuration of how to present the component in the dashboard. + */ + export interface Schema$Widget { + /** + * A blank space. + */ + blank?: Schema$Empty; + /** + * A scorecard summarizing time series data. + */ + scorecard?: Schema$Scorecard; + /** + * A raw string or markdown displaying textual content. + */ + text?: Schema$Text; + /** + * Optional. The title of the widget. + */ + title?: string | null; + /** + * A chart of time series data. + */ + xyChart?: Schema$XyChart; + } + /** + * A chart that displays data on a 2D (X and Y axes) plane. + */ + export interface Schema$XyChart { + /** + * Display options for the chart. + */ + chartOptions?: Schema$ChartOptions; + /** + * The data displayed in this chart. + */ + dataSets?: Schema$DataSet[]; + /** + * Threshold lines drawn horizontally across the chart. + */ + thresholds?: Schema$Threshold[]; + /** + * The duration used to display a comparison chart. A comparison chart simultaneously shows values from two similar-length time periods (e.g., week-over-week metrics). The duration must be positive, and it can only be applied to charts with data sets of LINE plot type. + */ + timeshiftDuration?: string | null; + /** + * The properties applied to the X axis. + */ + xAxis?: Schema$Axis; + /** + * The properties applied to the Y axis. + */ + yAxis?: Schema$Axis; + } + + export class Resource$Projects { + context: APIRequestContext; + dashboards: Resource$Projects$Dashboards; + constructor(context: APIRequestContext) { + this.context = context; + this.dashboards = new Resource$Projects$Dashboards(this.context); + } + } + + export class Resource$Projects$Dashboards { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * monitoring.projects.dashboards.create + * @desc Creates a new custom dashboard.This method requires the monitoring.dashboards.create permission on the specified project. For more information, see Google Cloud IAM (https://cloud.google.com/iam). + * @alias monitoring.projects.dashboards.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The project on which to execute the request. The format is "projects/{project_id_or_number}". The {project_id_or_number} must match the dashboard resource name. + * @param {().Dashboard} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params?: Params$Resource$Projects$Dashboards$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Dashboards$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Dashboards$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Dashboards$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Dashboards$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Dashboards$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://monitoring.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/dashboards').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * monitoring.projects.dashboards.delete + * @desc Deletes an existing custom dashboard.This method requires the monitoring.dashboards.delete permission on the specified dashboard. For more information, see Google Cloud IAM (https://cloud.google.com/iam). + * @alias monitoring.projects.dashboards.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name of the Dashboard. The format is "projects/{project_id_or_number}/dashboards/{dashboard_id}". + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Projects$Dashboards$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Dashboards$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Dashboards$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Dashboards$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Dashboards$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Dashboards$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://monitoring.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * monitoring.projects.dashboards.get + * @desc Fetches a specific dashboard.This method requires the monitoring.dashboards.get permission on the specified dashboard. For more information, see Google Cloud IAM (https://cloud.google.com/iam). + * @alias monitoring.projects.dashboards.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name of the Dashboard. The format is one of "dashboards/{dashboard_id}" (for system dashboards) or "projects/{project_id_or_number}/dashboards/{dashboard_id}" (for custom dashboards). + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Projects$Dashboards$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Dashboards$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Dashboards$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Dashboards$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Dashboards$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Dashboards$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://monitoring.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * monitoring.projects.dashboards.list + * @desc Lists the existing dashboards.This method requires the monitoring.dashboards.list permission on the specified project. For more information, see Google Cloud IAM (https://cloud.google.com/iam). + * @alias monitoring.projects.dashboards.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize A positive number that is the maximum number of results to return. If unspecified, a default of 1000 is used. + * @param {string=} params.pageToken If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. + * @param {string} params.parent Required. The scope of the dashboards to list. A project scope must be specified in the form of "projects/{project_id_or_number}". + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$Dashboards$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Dashboards$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Dashboards$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Dashboards$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Dashboards$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Dashboards$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://monitoring.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/dashboards').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * monitoring.projects.dashboards.patch + * @desc Replaces an existing custom dashboard with a new definition.This method requires the monitoring.dashboards.update permission on the specified dashboard. For more information, see Google Cloud IAM (https://cloud.google.com/iam). + * @alias monitoring.projects.dashboards.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The resource name of the dashboard. + * @param {().Dashboard} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Projects$Dashboards$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Dashboards$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Dashboards$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Dashboards$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Dashboards$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Dashboards$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://monitoring.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Dashboards$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The project on which to execute the request. The format is "projects/{project_id_or_number}". The {project_id_or_number} must match the dashboard resource name. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Dashboard; + } + export interface Params$Resource$Projects$Dashboards$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the Dashboard. The format is "projects/{project_id_or_number}/dashboards/{dashboard_id}". + */ + name?: string; + } + export interface Params$Resource$Projects$Dashboards$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the Dashboard. The format is one of "dashboards/{dashboard_id}" (for system dashboards) or "projects/{project_id_or_number}/dashboards/{dashboard_id}" (for custom dashboards). + */ + name?: string; + } + export interface Params$Resource$Projects$Dashboards$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A positive number that is the maximum number of results to return. If unspecified, a default of 1000 is used. + */ + pageSize?: number; + /** + * If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. + */ + pageToken?: string; + /** + * Required. The scope of the dashboards to list. A project scope must be specified in the form of "projects/{project_id_or_number}". + */ + parent?: string; + } + export interface Params$Resource$Projects$Dashboards$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The resource name of the dashboard. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Dashboard; + } } diff --git a/src/apis/monitoring/v3.ts b/src/apis/monitoring/v3.ts index d3cd651c0f8..3c448f3e768 100644 --- a/src/apis/monitoring/v3.ts +++ b/src/apis/monitoring/v3.ts @@ -145,11 +145,11 @@ export namespace monitoring_v3 { */ export interface Schema$AlertPolicy { /** - * How to combine the results of multiple conditions to determine if an incident should be opened. + * How to combine the results of multiple conditions to determine if an incident should be opened. If condition_time_series_query_language is present, this must be COMBINE_UNSPECIFIED. */ combiner?: string | null; /** - * A list of conditions for the policy. The conditions are combined by AND or OR according to the combiner field. If the combined conditions evaluate to true, then an incident is created. A policy can have from one to six conditions. + * A list of conditions for the policy. The conditions are combined by AND or OR according to the combiner field. If the combined conditions evaluate to true, then an incident is created. A policy can have from one to six conditions. If |condition_time_series_uery_language| is present, it must be the only |condition|. */ conditions?: Schema$Condition[]; /** @@ -1046,7 +1046,7 @@ export namespace monitoring_v3 { */ type?: string | null; /** - * The unit in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are a subset of The Unified Code for Units of Measure (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit By byte s second min minute h hour d dayPrefixes (PREFIX) k kilo (10**3) M mega (10**6) G giga (10**9) T tera (10**12) P peta (10**15) E exa (10**18) Z zetta (10**21) Y yotta (10**24) m milli (10**-3) u micro (10**-6) n nano (10**-9) p pico (10**-12) f femto (10**-15) a atto (10**-18) z zepto (10**-21) y yocto (10**-24) Ki kibi (2**10) Mi mebi (2**20) Gi gibi (2**30) Ti tebi (2**40)GrammarThe grammar also includes these connectors: / division (as an infix operator, e.g. 1/s). . multiplication (as an infix operator, e.g. GBy.d)The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: Annotation is just a comment if it follows a UNIT and is equivalent to 1 if it is used alone. For examples, {requests}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of non-blank printable ASCII characters not containing '{' or '}'. 1 represents dimensionless value 1, such as in 1/s. % represents dimensionless value 1/100, and annotates values giving a percentage. + * The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.Different systems may scale the values to be more easily displayed (so a value of 0.02KBy might be displayed as 20By, and a value of 3523KBy might be displayed as 3.5MBy). However, if the unit is KBy, then the value of the metric is always in thousands of bytes, no matter how it may be displayed..If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005.Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024).The supported units are a subset of The Unified Code for Units of Measure (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit By byte s second min minute h hour d dayPrefixes (PREFIX) k kilo (10^3) M mega (10^6) G giga (10^9) T tera (10^12) P peta (10^15) E exa (10^18) Z zetta (10^21) Y yotta (10^24) m milli (10^-3) u micro (10^-6) n nano (10^-9) p pico (10^-12) f femto (10^-15) a atto (10^-18) z zepto (10^-21) y yocto (10^-24) Ki kibi (2^10) Mi mebi (2^20) Gi gibi (2^30) Ti tebi (2^40) Pi pebi (2^50)GrammarThe grammar also includes these connectors: / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h.The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of non-blank printable ASCII characters not containing { or }. 1 represents a unitary dimensionless unit (https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent"). */ unit?: string | null; /** @@ -1246,10 +1246,6 @@ export namespace monitoring_v3 { * The full REST resource name for this descriptor. The syntax is: projects/[PROJECT_ID]/notificationChannelDescriptors/[TYPE] In the above, [TYPE] is the value of the type field. */ name?: string | null; - /** - * The tiers that support this notification channel; the project service tier must be one of the supported_tiers. - */ - supportedTiers?: string[] | null; /** * The type of notification channel, such as "email", "sms", etc. Notification channel types are globally unique. */ @@ -1404,7 +1400,7 @@ export namespace monitoring_v3 { */ displayName?: string | null; /** - * The fraction of service that must be good in order for this objective to be met. 0 < goal <= 1. + * The fraction of service that must be good in order for this objective to be met. 0 < goal <= 0.999. */ goal?: number | null; /** @@ -5922,7 +5918,7 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Resource name of the Service to delete. Of the form projects/{project_id}/service/{service_id}. + * @param {string} params.name Resource name of the Service to delete. Of the form projects/{project_id}/services/{service_id}. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -6227,7 +6223,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the Service to delete. Of the form projects/{project_id}/service/{service_id}. + * Resource name of the Service to delete. Of the form projects/{project_id}/services/{service_id}. */ name?: string; } diff --git a/src/apis/policytroubleshooter/index.ts b/src/apis/policytroubleshooter/index.ts index 36e57147e3c..4b031173274 100644 --- a/src/apis/policytroubleshooter/index.ts +++ b/src/apis/policytroubleshooter/index.ts @@ -14,12 +14,20 @@ /*! THIS FILE IS AUTO-GENERATED */ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; +import {policytroubleshooter_v1} from './v1'; import {policytroubleshooter_v1beta} from './v1beta'; export const VERSIONS = { + v1: policytroubleshooter_v1.Policytroubleshooter, v1beta: policytroubleshooter_v1beta.Policytroubleshooter, }; +export function policytroubleshooter( + version: 'v1' +): policytroubleshooter_v1.Policytroubleshooter; +export function policytroubleshooter( + options: policytroubleshooter_v1.Options +): policytroubleshooter_v1.Policytroubleshooter; export function policytroubleshooter( version: 'v1beta' ): policytroubleshooter_v1beta.Policytroubleshooter; @@ -27,10 +35,16 @@ export function policytroubleshooter( options: policytroubleshooter_v1beta.Options ): policytroubleshooter_v1beta.Policytroubleshooter; export function policytroubleshooter< - T = policytroubleshooter_v1beta.Policytroubleshooter + T = + | policytroubleshooter_v1.Policytroubleshooter + | policytroubleshooter_v1beta.Policytroubleshooter >( this: GoogleConfigurable, - versionOrOptions: 'v1beta' | policytroubleshooter_v1beta.Options + versionOrOptions: + | 'v1' + | policytroubleshooter_v1.Options + | 'v1beta' + | policytroubleshooter_v1beta.Options ) { return getAPI('policytroubleshooter', versionOrOptions, VERSIONS, this); } diff --git a/src/apis/policytroubleshooter/v1.ts b/src/apis/policytroubleshooter/v1.ts new file mode 100644 index 00000000000..f48cbb91615 --- /dev/null +++ b/src/apis/policytroubleshooter/v1.ts @@ -0,0 +1,434 @@ +// Copyright 2019 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, +} from 'google-auth-library'; +import { + GoogleConfigurable, + createAPIRequest, + MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace policytroubleshooter_v1 { + export interface Options extends GlobalOptions { + version: 'v1'; + } + + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * Policy Troubleshooter API + * + * + * + * @example + * const {google} = require('googleapis'); + * const policytroubleshooter = google.policytroubleshooter('v1'); + * + * @namespace policytroubleshooter + * @type {Function} + * @version v1 + * @variation v1 + * @param {object=} options Options for Policytroubleshooter + */ + export class Policytroubleshooter { + context: APIRequestContext; + iam: Resource$Iam; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.iam = new Resource$Iam(this.context); + } + } + + /** + * Information about the member, resource, and permission to check. + */ + export interface Schema$GoogleCloudPolicytroubleshooterV1AccessTuple { + /** + * Required. The full resource name that identifies the resource. For example, `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names. + */ + fullResourceName?: string | null; + /** + * Required. The IAM permission to check for the specified member and resource. For a complete list of IAM permissions, see https://cloud.google.com/iam/help/permissions/reference. For a complete list of predefined IAM roles and the permissions in each role, see https://cloud.google.com/iam/help/roles/reference. + */ + permission?: string | null; + /** + * Required. The member, or principal, whose access you want to check, in the form of the email address that represents that member. For example, `alice@example.com` or `my-service-account@my-project.iam.gserviceaccount.com`. The member must be a Google Account or a service account. Other types of members are not supported. + */ + principal?: string | null; + } + /** + * Details about how a binding in a policy affects a member's ability to use a permission. + */ + export interface Schema$GoogleCloudPolicytroubleshooterV1BindingExplanation { + /** + * Required. Indicates whether _this binding_ provides the specified permission to the specified member for the specified resource. This field does _not_ indicate whether the member actually has the permission for the resource. There might be another binding that overrides this binding. To determine whether the member actually has the permission, use the `access` field in the TroubleshootIamPolicyResponse. + */ + access?: string | null; + /** + * A condition expression that prevents access unless the expression evaluates to `true`. To learn about IAM Conditions, see http://cloud.google.com/iam/help/conditions/overview. + */ + condition?: Schema$GoogleTypeExpr; + /** + * Indicates whether each member in the binding includes the member specified in the request, either directly or indirectly. Each key identifies a member in the binding, and each value indicates whether the member in the binding includes the member in the request. For example, suppose that a binding includes the following members: * `user:alice@example.com` * `group:product-eng@example.com` You want to troubleshoot access for `user:bob@example.com`. This user is a member of the group `group:product-eng@example.com`. For the first member in the binding, the key is `user:alice@example.com`, and the `membership` field in the value is set to `MEMBERSHIP_NOT_INCLUDED`. For the second member in the binding, the key is `group:product-eng@example.com`, and the `membership` field in the value is set to `MEMBERSHIP_INCLUDED`. + */ + memberships?: { + [key: string]: Schema$GoogleCloudPolicytroubleshooterV1BindingExplanationAnnotatedMembership; + } | null; + /** + * The relevance of this binding to the overall determination for the entire policy. + */ + relevance?: string | null; + /** + * The role that this binding grants. For example, `roles/compute.serviceAgent`. For a complete list of predefined IAM roles, as well as the permissions in each role, see https://cloud.google.com/iam/help/roles/reference. + */ + role?: string | null; + /** + * Indicates whether the role granted by this binding contains the specified permission. + */ + rolePermission?: string | null; + /** + * The relevance of the permission's existence, or nonexistence, in the role to the overall determination for the entire policy. + */ + rolePermissionRelevance?: string | null; + } + /** + * Details about whether the binding includes the member. + */ + export interface Schema$GoogleCloudPolicytroubleshooterV1BindingExplanationAnnotatedMembership { + /** + * Indicates whether the binding includes the member. + */ + membership?: string | null; + /** + * The relevance of the member's status to the overall determination for the binding. + */ + relevance?: string | null; + } + /** + * Details about how a specific IAM Policy contributed to the access check. + */ + export interface Schema$GoogleCloudPolicytroubleshooterV1ExplainedPolicy { + /** + * Indicates whether _this policy_ provides the specified permission to the specified member for the specified resource. This field does _not_ indicate whether the member actually has the permission for the resource. There might be another policy that overrides this policy. To determine whether the member actually has the permission, use the `access` field in the TroubleshootIamPolicyResponse. + */ + access?: string | null; + /** + * Details about how each binding in the policy affects the member's ability, or inability, to use the permission for the resource. If the sender of the request does not have access to the policy, this field is omitted. + */ + bindingExplanations?: Schema$GoogleCloudPolicytroubleshooterV1BindingExplanation[]; + /** + * The full resource name that identifies the resource. For example, `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. If the sender of the request does not have access to the policy, this field is omitted. For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names. + */ + fullResourceName?: string | null; + /** + * The IAM policy attached to the resource. If the sender of the request does not have access to the policy, this field is empty. + */ + policy?: Schema$GoogleIamV1Policy; + /** + * The relevance of this policy to the overall determination in the TroubleshootIamPolicyResponse. If the sender of the request does not have access to the policy, this field is omitted. + */ + relevance?: string | null; + } + /** + * Request for TroubleshootIamPolicy. + */ + export interface Schema$GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyRequest { + /** + * The information to use for checking whether a member has a permission for a resource. + */ + accessTuple?: Schema$GoogleCloudPolicytroubleshooterV1AccessTuple; + } + /** + * Response for TroubleshootIamPolicy. + */ + export interface Schema$GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyResponse { + /** + * Indicates whether the member has the specified permission for the specified resource, based on evaluating all of the applicable IAM policies. + */ + access?: string | null; + /** + * List of IAM policies that were evaluated to check the member's permissions, with annotations to indicate how each policy contributed to the final result. The list of policies can include the policy for the resource itself. It can also include policies that are inherited from higher levels of the resource hierarchy, including the organization, the folder, and the project. To learn more about the resource hierarchy, see https://cloud.google.com/iam/help/resource-hierarchy. + */ + explainedPolicies?: Schema$GoogleCloudPolicytroubleshooterV1ExplainedPolicy[]; + } + /** + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + */ + export interface Schema$GoogleIamV1AuditConfig { + /** + * The configuration for logging of each type of permission. + */ + auditLogConfigs?: Schema$GoogleIamV1AuditLogConfig[]; + /** + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. + */ + service?: string | null; + } + /** + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. + */ + export interface Schema$GoogleIamV1AuditLogConfig { + /** + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. + */ + exemptedMembers?: string[] | null; + /** + * The log type that this config enables. + */ + logType?: string | null; + } + /** + * Associates `members` with a `role`. + */ + export interface Schema$GoogleIamV1Binding { + /** + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. + */ + condition?: Schema$GoogleTypeExpr; + /** + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + */ + members?: string[] | null; + /** + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + */ + role?: string | null; + } + /** + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + */ + export interface Schema$GoogleIamV1Policy { + /** + * Specifies cloud audit logging configuration for this policy. + */ + auditConfigs?: Schema$GoogleIamV1AuditConfig[]; + /** + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + */ + bindings?: Schema$GoogleIamV1Binding[]; + /** + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. + */ + etag?: string | null; + /** + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. + */ + version?: number | null; + } + /** + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + */ + export interface Schema$GoogleTypeExpr { + /** + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + */ + description?: string | null; + /** + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + */ + expression?: string | null; + /** + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + */ + location?: string | null; + /** + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + */ + title?: string | null; + } + + export class Resource$Iam { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * policytroubleshooter.iam.troubleshoot + * @desc Checks whether a member has a specific permission for a specific resource, and explains why the member does or does not have that permission. + * @alias policytroubleshooter.iam.troubleshoot + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + troubleshoot( + params?: Params$Resource$Iam$Troubleshoot, + options?: MethodOptions + ): GaxiosPromise< + Schema$GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyResponse + >; + troubleshoot( + params: Params$Resource$Iam$Troubleshoot, + options: + | MethodOptions + | BodyResponseCallback< + Schema$GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyResponse + >, + callback: BodyResponseCallback< + Schema$GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyResponse + > + ): void; + troubleshoot( + params: Params$Resource$Iam$Troubleshoot, + callback: BodyResponseCallback< + Schema$GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyResponse + > + ): void; + troubleshoot( + callback: BodyResponseCallback< + Schema$GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyResponse + > + ): void; + troubleshoot( + paramsOrCallback?: + | Params$Resource$Iam$Troubleshoot + | BodyResponseCallback< + Schema$GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyResponse + >, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback< + Schema$GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyResponse + >, + callback?: BodyResponseCallback< + Schema$GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyResponse + > + ): void | GaxiosPromise< + Schema$GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyResponse + > { + let params = (paramsOrCallback || {}) as Params$Resource$Iam$Troubleshoot; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Iam$Troubleshoot; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://policytroubleshooter.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/iam:troubleshoot').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest< + Schema$GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyResponse + >(parameters, callback); + } else { + return createAPIRequest< + Schema$GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyResponse + >(parameters); + } + } + } + + export interface Params$Resource$Iam$Troubleshoot extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyRequest; + } +} diff --git a/src/apis/policytroubleshooter/v1beta.ts b/src/apis/policytroubleshooter/v1beta.ts index b6788aa532f..f99d383c1c0 100644 --- a/src/apis/policytroubleshooter/v1beta.ts +++ b/src/apis/policytroubleshooter/v1beta.ts @@ -116,114 +116,114 @@ export namespace policytroubleshooter_v1beta { } /** - * AccessTuple defines information required for checking an access attempt. In other words, this is the tuple given to `CheckAccess`. + * Information about the member, resource, and permission to check. */ export interface Schema$GoogleCloudPolicytroubleshooterV1betaAccessTuple { /** - * Required. A full resource name according to https://cloud.google.com/apis/design/resource_names. This is the full resource name of the resource that access is checked against. + * Required. The full resource name that identifies the resource. For example, `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names. */ fullResourceName?: string | null; /** - * Required. The Cloud IAM permission under which defines the kind of access being explained. Example: "resourcemanager.projects.get" would explain if and why the principal has the resourcemanager.projects.get permission on the resource specified in full_resource_name declared in this structure. See https://cloud.google.com/iam/docs/testing-permissions + * Required. The IAM permission to check for the specified member and resource. For a complete list of IAM permissions, see https://cloud.google.com/iam/help/permissions/reference. For a complete list of predefined IAM roles and the permissions in each role, see https://cloud.google.com/iam/help/roles/reference. */ permission?: string | null; /** - * Required. The principal on behalf of who the access is explained for. The format is one of the principal's email addresses associated with its gaia account. It must be an account that can appear as an actor. For example groups are not supported. Currently, service accounts, users are supported. + * Required. The member, or principal, whose access you want to check, in the form of the email address that represents that member. For example, `alice@example.com` or `my-service-account@my-project.iam.gserviceaccount.com`. The member must be a Google Account or a service account. Other types of members are not supported. */ principal?: string | null; } /** - * Binding Explanation. + * Details about how a binding in a policy affects a member's ability to use a permission. */ export interface Schema$GoogleCloudPolicytroubleshooterV1betaBindingExplanation { /** - * REQUIRED: Access decision for this binding. + * Indicates whether _this binding_ provides the specified permission to the specified member for the specified resource. This field does _not_ indicate whether the member actually has the permission for the resource. There might be another binding that overrides this binding. To determine whether the member actually has the permission, use the `access` field in the TroubleshootIamPolicyResponse. */ access?: string | null; /** - * The condition which needs to be satisfied in order for this binding to grant the role to the principal. See https://cloud.google.com/iam/docs/conditions-base + * A condition expression that prevents access unless the expression evaluates to `true`. To learn about IAM Conditions, see http://cloud.google.com/iam/help/conditions/overview. */ condition?: Schema$GoogleTypeExpr; /** - * For each member in the binding, provides information whether or not the principal from the request is included in the member by which the CheckResult is keyed. May indicate that the caller has no access to this information. example key: 'group:cloud-iam-assist-eng@google.com' example value '{NOT_GRANTED, HIGH} + * Indicates whether each member in the binding includes the member specified in the request, either directly or indirectly. Each key identifies a member in the binding, and each value indicates whether the member in the binding includes the member in the request. For example, suppose that a binding includes the following members: * `user:alice@example.com` * `group:product-eng@example.com` You want to troubleshoot access for `user:bob@example.com`. This user is a member of the group `group:product-eng@example.com`. For the first member in the binding, the key is `user:alice@example.com`, and the `membership` field in the value is set to `MEMBERSHIP_NOT_INCLUDED`. For the second member in the binding, the key is `group:product-eng@example.com`, and the `membership` field in the value is set to `MEMBERSHIP_INCLUDED`. */ memberships?: { [key: string]: Schema$GoogleCloudPolicytroubleshooterV1betaBindingExplanationAnnotatedMembership; } | null; /** - * Bubbles up role_permission level relavance to BindingExplanation object. If role permission is NORMAL, then binding relevance is NORMAL. If role permission is HIGH, then binding relevance is HIGH. + * The relevance of this binding to the overall determination for the entire policy. */ relevance?: string | null; /** - * The role that this binding grants in the policy. for example "roles/compute.serviceAgent" + * The role that this binding grants. For example, `roles/compute.serviceAgent`. For a complete list of predefined IAM roles, as well as the permissions in each role, see https://cloud.google.com/iam/help/roles/reference. */ role?: string | null; /** - * Whether the role of this binding contains the checked permission + * Indicates whether the role granted by this binding contains the specified permission. */ rolePermission?: string | null; /** - * The relevance of this permission with respect to the BindingExplanation. + * The relevance of the permission's existence, or nonexistence, in the role to the overall determination for the entire policy. */ rolePermissionRelevance?: string | null; } /** - * Encapsulated membership and the relevance of that membership with respect to BindingExplanation. + * Details about whether the binding includes the member. */ export interface Schema$GoogleCloudPolicytroubleshooterV1betaBindingExplanationAnnotatedMembership { /** - * Membership status. + * Indicates whether the binding includes the member. */ membership?: string | null; /** - * Relevance of this membership with respect to BindingExplanation. + * The relevance of the member's status to the overall determination for the binding. */ relevance?: string | null; } /** - * An explained IAM policy combines the raw policy in the context of the resource which it is attached to along with detailed evaluation on the evaluation parameters provided through the request. + * Details about how a specific IAM Policy contributed to the access check. */ export interface Schema$GoogleCloudPolicytroubleshooterV1betaExplainedPolicy { /** - * Access decision for this section of the resource's effective policy. + * Indicates whether _this policy_ provides the specified permission to the specified member for the specified resource. This field does _not_ indicate whether the member actually has the permission for the resource. There might be another policy that overrides this policy. To determine whether the member actually has the permission, use the `access` field in the TroubleshootIamPolicyResponse. */ access?: string | null; /** - * Detailed binding evaluation explanations provide information about how each binding contributes to the principal's access or the lack thereof. + * Details about how each binding in the policy affects the member's ability, or inability, to use the permission for the resource. If the sender of the request does not have access to the policy, this field is omitted. */ bindingExplanations?: Schema$GoogleCloudPolicytroubleshooterV1betaBindingExplanation[]; /** - * Resource that this section of the effective policy attaches to. + * The full resource name that identifies the resource. For example, `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. If the sender of the request does not have access to the policy, this field is omitted. For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names. */ fullResourceName?: string | null; /** - * The IAM policy attached to the resource. + * The IAM policy attached to the resource. If the sender of the request does not have access to the policy, this field is empty. */ policy?: Schema$GoogleIamV1Policy; /** - * Relevance of this Policy. + * The relevance of this policy to the overall determination in the TroubleshootIamPolicyResponse. If the sender of the request does not have access to the policy, this field is omitted. */ relevance?: string | null; } /** - * TroubleshootIamPolicyRequest is used in TroubleshootIamPolicy + * Request for TroubleshootIamPolicy. */ export interface Schema$GoogleCloudPolicytroubleshooterV1betaTroubleshootIamPolicyRequest { /** - * Collection of attributes for example user, permission, resource that define troubleshooter's input. + * The information to use for checking whether a member has a permission for a resource. */ accessTuple?: Schema$GoogleCloudPolicytroubleshooterV1betaAccessTuple; } /** - * TroubleshootIamPolicyResponse is used in TroubleshootIamPolicy. + * Response for TroubleshootIamPolicy. */ export interface Schema$GoogleCloudPolicytroubleshooterV1betaTroubleshootIamPolicyResponse { /** - * Reflects whether the probed access was granted, denied or ultimately could not be decided from the caller's point of view. + * Indicates whether the member has the specified permission for the specified resource, based on evaluating all of the applicable policies. */ access?: string | null; /** - * List of explained policies. Each explanation corresponds to one policy along the ancestry path. + * List of IAM policies that were evaluated to check the member's permissions, with annotations to indicate how each policy contributed to the final result. The list of policies can include the policy for the resource itself. It can also include policies that are inherited from higher levels of the resource hierarchy, including the organization, the folder, and the project. To learn more about the resource hierarchy, see https://cloud.google.com/iam/help/resource-hierarchy. */ explainedPolicies?: Schema$GoogleCloudPolicytroubleshooterV1betaExplainedPolicy[]; } @@ -262,7 +262,7 @@ export namespace policytroubleshooter_v1beta { */ condition?: Schema$GoogleTypeExpr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -271,7 +271,7 @@ export namespace policytroubleshooter_v1beta { role?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$GoogleIamV1Policy { /** @@ -279,15 +279,15 @@ export namespace policytroubleshooter_v1beta { */ auditConfigs?: Schema$GoogleIamV1AuditConfig[]; /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$GoogleIamV1Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if the incoming policy version does not meet the requirements for modifying the stored policy. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a binding (conditional or unconditional) from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, version compliance checks against the stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } @@ -321,7 +321,7 @@ export namespace policytroubleshooter_v1beta { /** * policytroubleshooter.iam.troubleshoot - * @desc Perform a check on whether a member is granted a permission on a resource and how that grant/deny is determined accordinga to the resource's effective IAM policy interpretation. + * @desc Checks whether a member has a specific permission for a specific resource, and explains why the member does or does not have that permission. * @alias policytroubleshooter.iam.troubleshoot * @memberOf! () * diff --git a/src/apis/fusiontables/README.md b/src/apis/prod_tt_sasportal/README.md similarity index 82% rename from src/apis/fusiontables/README.md rename to src/apis/prod_tt_sasportal/README.md index c71dee1d038..ea2d458320d 100644 --- a/src/apis/fusiontables/README.md +++ b/src/apis/prod_tt_sasportal/README.md @@ -1,8 +1,8 @@ Google Inc. logo -# fusiontables +# prod_tt_sasportal -> API for working with Fusion Tables data. +> ## Installation @@ -19,17 +19,17 @@ This library can be used in a browser. To prepare a single file bundle, clone th [repository](https://github.com/googleapis/google-api-nodejs-client) and run ```sh -$ cd src/apis/fusiontables +$ cd src/apis/prod_tt_sasportal $ npm install $ npm run webpack ``` -The generated bundle will be written to `dist/fusiontables.min.js`. Use it from your HTML file: +The generated bundle will be written to `dist/prod_tt_sasportal.min.js`. Use it from your HTML file: ```html - + ``` diff --git a/src/apis/fusiontables/index.ts b/src/apis/prod_tt_sasportal/index.ts similarity index 51% rename from src/apis/fusiontables/index.ts rename to src/apis/prod_tt_sasportal/index.ts index 8a414bf7e85..800336b2908 100644 --- a/src/apis/fusiontables/index.ts +++ b/src/apis/prod_tt_sasportal/index.ts @@ -14,33 +14,25 @@ /*! THIS FILE IS AUTO-GENERATED */ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; -import {fusiontables_v1} from './v1'; -import {fusiontables_v2} from './v2'; +import {prod_tt_sasportal_v1alpha1} from './v1alpha1'; export const VERSIONS = { - v1: fusiontables_v1.Fusiontables, - v2: fusiontables_v2.Fusiontables, + v1alpha1: prod_tt_sasportal_v1alpha1.Prod_tt_sasportal, }; -export function fusiontables(version: 'v1'): fusiontables_v1.Fusiontables; -export function fusiontables( - options: fusiontables_v1.Options -): fusiontables_v1.Fusiontables; -export function fusiontables(version: 'v2'): fusiontables_v2.Fusiontables; -export function fusiontables( - options: fusiontables_v2.Options -): fusiontables_v2.Fusiontables; -export function fusiontables< - T = fusiontables_v1.Fusiontables | fusiontables_v2.Fusiontables +export function prod_tt_sasportal( + version: 'v1alpha1' +): prod_tt_sasportal_v1alpha1.Prod_tt_sasportal; +export function prod_tt_sasportal( + options: prod_tt_sasportal_v1alpha1.Options +): prod_tt_sasportal_v1alpha1.Prod_tt_sasportal; +export function prod_tt_sasportal< + T = prod_tt_sasportal_v1alpha1.Prod_tt_sasportal >( this: GoogleConfigurable, - versionOrOptions: - | 'v1' - | fusiontables_v1.Options - | 'v2' - | fusiontables_v2.Options + versionOrOptions: 'v1alpha1' | prod_tt_sasportal_v1alpha1.Options ) { - return getAPI('fusiontables', versionOrOptions, VERSIONS, this); + return getAPI('prod_tt_sasportal', versionOrOptions, VERSIONS, this); } const auth = new AuthPlus(); diff --git a/src/apis/fusiontables/package.json b/src/apis/prod_tt_sasportal/package.json similarity index 92% rename from src/apis/fusiontables/package.json rename to src/apis/prod_tt_sasportal/package.json index 7943ed2c739..b7ba8aae9ff 100644 --- a/src/apis/fusiontables/package.json +++ b/src/apis/prod_tt_sasportal/package.json @@ -1,7 +1,7 @@ { - "name": "@google/fusiontables", + "name": "@google/prod_tt_sasportal", "version": "0.1.0", - "description": "fusiontables", + "description": "prod_tt_sasportal", "main": "build/index.js", "types": "build/index.d.ts", "keywords": [ diff --git a/src/apis/fusiontables/tsconfig.json b/src/apis/prod_tt_sasportal/tsconfig.json similarity index 100% rename from src/apis/fusiontables/tsconfig.json rename to src/apis/prod_tt_sasportal/tsconfig.json diff --git a/src/apis/prod_tt_sasportal/v1alpha1.ts b/src/apis/prod_tt_sasportal/v1alpha1.ts new file mode 100644 index 00000000000..c4917868c18 --- /dev/null +++ b/src/apis/prod_tt_sasportal/v1alpha1.ts @@ -0,0 +1,4427 @@ +// Copyright 2019 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, +} from 'google-auth-library'; +import { + GoogleConfigurable, + createAPIRequest, + MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace prod_tt_sasportal_v1alpha1 { + export interface Options extends GlobalOptions { + version: 'v1alpha1'; + } + + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * SAS Portal API (Testing) + * + * + * + * @example + * const {google} = require('googleapis'); + * const prod_tt_sasportal = google.prod_tt_sasportal('v1alpha1'); + * + * @namespace prod_tt_sasportal + * @type {Function} + * @version v1alpha1 + * @variation v1alpha1 + * @param {object=} options Options for Prod_tt_sasportal + */ + export class Prod_tt_sasportal { + context: APIRequestContext; + customers: Resource$Customers; + installer: Resource$Installer; + nodes: Resource$Nodes; + policies: Resource$Policies; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.customers = new Resource$Customers(this.context); + this.installer = new Resource$Installer(this.context); + this.nodes = new Resource$Nodes(this.context); + this.policies = new Resource$Policies(this.context); + } + } + + /** + * Associates `members` with a `role`. + */ + export interface Schema$SasPortalAssignment { + /** + * The identities the role is assigned to. It can have the following values: * `{user_email}`: An email address that represents a specific Google account. For example: `alice@gmail.com`. * `{group_email}`: An email address that represents a Google group. For example, `viewers@gmail.com`. + */ + members?: string[] | null; + /** + * Required. Role that is assigned to `members`. + */ + role?: string | null; + } + /** + * Request for BulkCreateDevice method. + */ + export interface Schema$SasPortalBulkCreateDeviceRequest { + /** + * Required. A csv with each row representing a [device]. Each row must conform to the regulations described on CreateDeviceRequest's device field. + */ + csv?: string | null; + } + /** + * Response for BulkCreateDevice method. + */ + export interface Schema$SasPortalBulkCreateDeviceResponse { + /** + * Required. The devices that were imported. + */ + devices?: Schema$SasPortalDevice[]; + } + /** + * Request for CreateSignedDevice method. + */ + export interface Schema$SasPortalCreateSignedDeviceRequest { + /** + * Required. JSON Web Token signed using a CPI private key. Payload must be the JSON encoding of the [Device]. + */ + encodedDevice?: string | null; + /** + * Required. Unique installer id (cpiId) from the Certified Professional Installers database. + */ + installerId?: string | null; + } + /** + * Entity representing a SAS customer. + */ + export interface Schema$SasPortalCustomer { + /** + * Required. Name of the organization that the customer entity represents. + */ + displayName?: string | null; + /** + * Output only. Resource name of the customer. + */ + name?: string | null; + /** + * User IDs used by the devices belonging to this customer. + */ + sasUserIds?: string[] | null; + } + export interface Schema$SasPortalDevice { + /** + * Output only. Current configuration of the device as registered to the SAS. + */ + activeConfig?: Schema$SasPortalDeviceConfig; + /** + * Device display name. + */ + displayName?: string | null; + /** + * The FCC identifier of the device. + */ + fccId?: string | null; + /** + * Output only. Grants held by the device. + */ + grants?: Schema$SasPortalDeviceGrant[]; + /** + * Output only. The resource path name. + */ + name?: string | null; + /** + * Configuration of the device, as specified via SAS Portal API. + */ + preloadedConfig?: Schema$SasPortalDeviceConfig; + /** + * A serial number assigned to the device by the device manufacturer. + */ + serialNumber?: string | null; + /** + * Output only. Device state. + */ + state?: string | null; + } + /** + * Information about the device's air interface. + */ + export interface Schema$SasPortalDeviceAirInterface { + /** + * This field specifies the radio access technology that is used for the CBSD. Conditional + */ + radioTechnology?: string | null; + /** + * This field is related to the radioTechnology field and provides the air interface specification that the CBSD is compliant with at the time of registration. Optional + */ + supportedSpec?: string | null; + } + /** + * Information about the device configuration. + */ + export interface Schema$SasPortalDeviceConfig { + /** + * Information about this device's air interface. + */ + airInterface?: Schema$SasPortalDeviceAirInterface; + /** + * The call sign of the device operator. + */ + callSign?: string | null; + /** + * FCC category of the device. + */ + category?: string | null; + /** + * Installation parameters for the device. + */ + installationParams?: Schema$SasPortalInstallationParams; + /** + * Output-only. Whether the configuration has been signed by a CPI. + */ + isSigned?: boolean | null; + /** + * Measurement reporting capabilities of the device. + */ + measurementCapabilities?: string[] | null; + /** + * Information about this device model. + */ + model?: Schema$SasPortalDeviceModel; + /** + * State of the configuration. + */ + state?: string | null; + /** + * Output-only. The last time the device configuration was edited. + */ + updateTime?: string | null; + /** + * Output only. The identifier of a device user. + */ + userId?: string | null; + } + /** + * Device grant. It is an authorization provided by the Spectrum Access System to a device to transmit using specified operating parameters after a successful heartbeat by the device. + */ + export interface Schema$SasPortalDeviceGrant { + /** + * Type of channel used. + */ + channelType?: string | null; + /** + * The expiration time of the grant. + */ + expireTime?: string | null; + /** + * The transmission frequency range. + */ + frequencyRange?: Schema$SasPortalFrequencyRange; + /** + * Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by the grant. The maximum EIRP is in units of dBm/MHz. The value of maxEirp represents the average (RMS) EIRP that would be measured by the procedure defined in FCC part 96.41(e)(3). + */ + maxEirp?: number | null; + /** + * The DPA move lists on which this grant appears. + */ + moveList?: Schema$SasPortalDpaMoveList[]; + /** + * State of the grant. + */ + state?: string | null; + } + /** + * Information about the model of the device. + */ + export interface Schema$SasPortalDeviceModel { + /** + * The firmware version of the device. + */ + firmwareVersion?: string | null; + /** + * The hardware version of the device. + */ + hardwareVersion?: string | null; + /** + * The name of the device model. + */ + name?: string | null; + /** + * The software version of the device. + */ + softwareVersion?: string | null; + /** + * The name of the device vendor. + */ + vendor?: string | null; + } + /** + * An entry in a DPA's move list. + */ + export interface Schema$SasPortalDpaMoveList { + /** + * The ID of the DPA. + */ + dpaId?: string | null; + /** + * The frequency range that the move list affects. + */ + frequencyRange?: Schema$SasPortalFrequencyRange; + } + /** + * 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$SasPortalEmpty {} + /** + * Frequency range from `low_frequency` to `high_frequency`. + */ + export interface Schema$SasPortalFrequencyRange { + /** + * The highest frequency of the frequency range in MHz. + */ + highFrequencyMhz?: number | null; + /** + * The lowest frequency of the frequency range in MHz. + */ + lowFrequencyMhz?: number | null; + } + /** + * Request for GenerateSecret method] [spectrum.sas.portal.v1alpha1.DeviceManager.GenerateSecret]. + */ + export interface Schema$SasPortalGenerateSecretRequest {} + /** + * Response for GenerateSecret method. + */ + export interface Schema$SasPortalGenerateSecretResponse { + /** + * The secret generated by the string and used by [ValidateInstaller] method. + */ + secret?: string | null; + } + /** + * Request message for `GetPolicy` method. + */ + export interface Schema$SasPortalGetPolicyRequest { + /** + * Required. The resource for which the policy is being requested. + */ + resource?: string | null; + } + /** + * Information about the device installation parameters. + */ + export interface Schema$SasPortalInstallationParams { + /** + * Boresight direction of the horizontal plane of the antenna in degrees with respect to true north. The value of this parameter is an integer with a value between 0 and 359 inclusive. A value of 0 degrees means true north; a value of 90 degrees means east. This parameter is optional for Category A devices and conditional for Category B devices. + */ + antennaAzimuth?: number | null; + /** + * 3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This parameter is an unsigned integer having a value between 0 and 360 (degrees) inclusive; it is optional for Category A devices and conditional for Category B devices. + */ + antennaBeamwidth?: number | null; + /** + * Antenna downtilt in degrees and is an integer with a value between -90 and +90 inclusive; a negative value means the antenna is tilted up (above horizontal). This parameter is optional for Category A devices and conditional for Category B devices. + */ + antennaDowntilt?: number | null; + /** + * Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. + */ + antennaGain?: number | null; + /** + * If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets. + */ + antennaModel?: string | null; + /** + * This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category. + */ + eirpCapability?: number | null; + /** + * Device antenna height in meters. When the heightType parameter value is "AGL", the antenna height should be given relative to ground level. When the heightType parameter value is "AMSL", it is given with respect to WGS84 datum. + */ + height?: number | null; + /** + * Specifies how the height is measured. + */ + heightType?: string | null; + /** + * A positive number in meters to indicate accuracy of the device antenna horizontal location. This optional parameter should only be present if its value is less than the FCC requirement of 50 meters. + */ + horizontalAccuracy?: number | null; + /** + * Whether the device antenna is indoor or not. True: indoor. False: outdoor. + */ + indoorDeployment?: boolean | null; + /** + * Latitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator. + */ + latitude?: number | null; + /** + * Longitude of the device antenna location. in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian. + */ + longitude?: number | null; + /** + * A positive number in meters to indicate accuracy of the device antenna vertical location. This optional parameter should only be present if its value is less than the FCC requirement of 3 meters. + */ + verticalAccuracy?: number | null; + } + /** + * Response for `ListCustomers`. + */ + export interface Schema$SasPortalListCustomersResponse { + /** + * The list of customers that match the request. + */ + customers?: Schema$SasPortalCustomer[]; + /** + * A pagination token returned from a previous call to ListCustomers method that indicates from where listing should continue. If the field is missing or empty, it means there are no more customers. + */ + nextPageToken?: string | null; + } + /** + * Response for ListDevices method. + */ + export interface Schema$SasPortalListDevicesResponse { + /** + * The devices that match the request. + */ + devices?: Schema$SasPortalDevice[]; + /** + * A pagination token returned from a previous call to ListDevices method that indicates from where listing should continue. If the field is missing or empty, it means there is no more devices. + */ + nextPageToken?: string | null; + } + /** + * Response for ListNodes method. + */ + export interface Schema$SasPortalListNodesResponse { + /** + * A pagination token returned from a previous call to ListNodes method that indicates from where listing should continue. If the field is missing or empty, it means there is no more nodes. + */ + nextPageToken?: string | null; + /** + * The nodes that match the request. + */ + nodes?: Schema$SasPortalNode[]; + } + /** + * Request for MoveDevice method. + */ + export interface Schema$SasPortalMoveDeviceRequest { + /** + * Required. The name of the new parent resource (Node or Customer) to reparent the device under. + */ + destination?: string | null; + } + /** + * Request for MoveNode method. + */ + export interface Schema$SasPortalMoveNodeRequest { + /** + * Required. The name of the new parent resource node or Customer) to reparent the node under. + */ + destination?: string | null; + } + /** + * The Node. + */ + export interface Schema$SasPortalNode { + /** + * The node's display name. + */ + displayName?: string | null; + /** + * Output only. Resource name. + */ + name?: string | null; + /** + * User ids used by the devices belonging to this node. + */ + sasUserIds?: string[] | null; + } + /** + * This resource represents a long-running operation that is the result of a network API call. + */ + export interface Schema$SasPortalOperation { + /** + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. + */ + done?: boolean | null; + /** + * The error result of the operation in case of failure or cancellation. + */ + error?: Schema$SasPortalStatus; + /** + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + */ + metadata?: {[key: string]: any} | null; + /** + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. + */ + name?: string | null; + /** + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + */ + response?: {[key: string]: any} | null; + } + /** + * Defines an access control policy to the resources. + */ + export interface Schema$SasPortalPolicy { + assignments?: Schema$SasPortalAssignment[]; + /** + * The [etag] is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the [etag] in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An [etag] is returned in the response to [GetPolicy], and systems are expected to put that etag in the request to [SetPolicy] to ensure that their change will be applied to the same version of the policy. If no [etag] is provided in the call to [SetPolicy], then the existing policy is overwritten blindly. + */ + etag?: string | null; + } + /** + * Request message for `SetPolicy` method. + */ + export interface Schema$SasPortalSetPolicyRequest { + /** + * Required. The policy to be applied to the `resource`. + */ + policy?: Schema$SasPortalPolicy; + /** + * Required. The resource for which the policy is being specified. This policy replaces any existing policy. + */ + resource?: string | null; + } + /** + * Request for SignDevice method. + */ + export interface Schema$SasPortalSignDeviceRequest { + /** + * Required. The device to sign. The device fields name, fcc_id and serial_number must be set. + */ + device?: Schema$SasPortalDevice; + } + /** + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + */ + export interface Schema$SasPortalStatus { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number | null; + /** + * A list of messages that carry the error details. There is a common set of message types for APIs to use. + */ + details?: Array<{[key: string]: any}> | null; + /** + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + */ + message?: string | null; + } + /** + * Request message for `TestPermissions` method. + */ + export interface Schema$SasPortalTestPermissionsRequest { + /** + * The set of permissions to check for the `resource`. + */ + permissions?: string[] | null; + /** + * Required. The resource for which the permissions are being requested. + */ + resource?: string | null; + } + /** + * Response message for `TestPermissions` method. + */ + export interface Schema$SasPortalTestPermissionsResponse { + /** + * A set of permissions that the caller is allowed. + */ + permissions?: string[] | null; + } + /** + * Request for UpdateSignedDevice method. + */ + export interface Schema$SasPortalUpdateSignedDeviceRequest { + /** + * Required. The JSON Web Token signed using a CPI private key. Payload must be the JSON encoding of the device. + */ + encodedDevice?: string | null; + /** + * Required. Unique installer ID (CPI ID) from the Certified Professional Installers database. + */ + installerId?: string | null; + } + /** + * Request for ValidateInstaller method. + */ + export interface Schema$SasPortalValidateInstallerRequest { + /** + * Required. JSON Web Token signed using a CPI private key. Payload must include a "secret" claim whose value is the secret. + */ + encodedSecret?: string | null; + /** + * Required. Unique installer id (cpiId) from the Certified Professional Installers database. + */ + installerId?: string | null; + /** + * Required. Secret returned by the GenerateSecret method. + */ + secret?: string | null; + } + /** + * Response for ValidateInstaller method] [spectrum.sas.portal.v1alpha1.DeviceManager.ValidateInstaller]. + */ + export interface Schema$SasPortalValidateInstallerResponse {} + + export class Resource$Customers { + context: APIRequestContext; + devices: Resource$Customers$Devices; + nodes: Resource$Customers$Nodes; + constructor(context: APIRequestContext) { + this.context = context; + this.devices = new Resource$Customers$Devices(this.context); + this.nodes = new Resource$Customers$Nodes(this.context); + } + + /** + * prod_tt_sasportal.customers.get + * @desc Returns a requested customer. + * @alias prod_tt_sasportal.customers.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the customer. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Customers$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Customers$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Customers$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Customers$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Customers$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * prod_tt_sasportal.customers.list + * @desc Returns a list of requested customers. + * @alias prod_tt_sasportal.customers.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize The maximum number of customers to return in the response. + * @param {string=} params.pageToken A pagination token returned from a previous call to ListCustomers method that indicates where this listing should continue from. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Customers$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Customers$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Customers$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Customers$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Customers$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/customers').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * prod_tt_sasportal.customers.patch + * @desc Updates an existing customer. + * @alias prod_tt_sasportal.customers.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Output only. Resource name of the customer. + * @param {string=} params.updateMask Fields to be updated. + * @param {().SasPortalCustomer} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Customers$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Customers$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Customers$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Customers$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Customers$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Customers$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the customer. + */ + name?: string; + } + export interface Params$Resource$Customers$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The maximum number of customers to return in the response. + */ + pageSize?: number; + /** + * A pagination token returned from a previous call to ListCustomers method that indicates where this listing should continue from. + */ + pageToken?: string; + } + export interface Params$Resource$Customers$Patch extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Output only. Resource name of the customer. + */ + name?: string; + /** + * Fields to be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalCustomer; + } + + export class Resource$Customers$Devices { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * prod_tt_sasportal.customers.devices.bulk + * @desc Creates a device under a node or customer. Returned devices are unordered. + * @alias prod_tt_sasportal.customers.devices.bulk + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The name of the parent resource. + * @param {().SasPortalBulkCreateDeviceRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + bulk( + params?: Params$Resource$Customers$Devices$Bulk, + options?: MethodOptions + ): GaxiosPromise; + bulk( + params: Params$Resource$Customers$Devices$Bulk, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulk( + params: Params$Resource$Customers$Devices$Bulk, + callback: BodyResponseCallback + ): void; + bulk( + callback: BodyResponseCallback + ): void; + bulk( + paramsOrCallback?: + | Params$Resource$Customers$Devices$Bulk + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customers$Devices$Bulk; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Devices$Bulk; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/devices:bulk').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * prod_tt_sasportal.customers.devices.create + * @desc Creates a device under a node or customer. + * @alias prod_tt_sasportal.customers.devices.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The name of the parent resource. + * @param {().SasPortalDevice} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params?: Params$Resource$Customers$Devices$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Customers$Devices$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Customers$Devices$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Customers$Devices$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customers$Devices$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Devices$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/devices').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * prod_tt_sasportal.customers.devices.createSigned + * @desc Creates a signed device under a node or customer. + * @alias prod_tt_sasportal.customers.devices.createSigned + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The name of the parent resource. + * @param {().SasPortalCreateSignedDeviceRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + createSigned( + params?: Params$Resource$Customers$Devices$Createsigned, + options?: MethodOptions + ): GaxiosPromise; + createSigned( + params: Params$Resource$Customers$Devices$Createsigned, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + createSigned( + params: Params$Resource$Customers$Devices$Createsigned, + callback: BodyResponseCallback + ): void; + createSigned(callback: BodyResponseCallback): void; + createSigned( + paramsOrCallback?: + | Params$Resource$Customers$Devices$Createsigned + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customers$Devices$Createsigned; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Devices$Createsigned; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/devices:createSigned').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * prod_tt_sasportal.customers.devices.delete + * @desc Deletes a device. + * @alias prod_tt_sasportal.customers.devices.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the device. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Customers$Devices$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Customers$Devices$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Customers$Devices$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Customers$Devices$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customers$Devices$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Devices$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * prod_tt_sasportal.customers.devices.get + * @desc Gets details about a device. + * @alias prod_tt_sasportal.customers.devices.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the device. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Customers$Devices$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Customers$Devices$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Customers$Devices$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Customers$Devices$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customers$Devices$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Devices$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * prod_tt_sasportal.customers.devices.list + * @desc Lists devices under a node or customer. + * @alias prod_tt_sasportal.customers.devices.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter The filter expression. The filter should have one of the following formats: "sn=123454" or "display_name=MyDevice". sn corresponds to serial_number of the device. The filter is case insensitive. + * @param {integer=} params.pageSize The maximum number of devices to return in the response. + * @param {string=} params.pageToken A pagination token returned from a previous call to ListDevices that indicates where this listing should continue from. + * @param {string} params.parent Required. The name of the parent 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 + */ + list( + params?: Params$Resource$Customers$Devices$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Customers$Devices$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Customers$Devices$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Customers$Devices$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customers$Devices$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Devices$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/devices').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * prod_tt_sasportal.customers.devices.move + * @desc Moves a device under another node or customer. + * @alias prod_tt_sasportal.customers.devices.move + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the device to move. + * @param {().SasPortalMoveDeviceRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + move( + params?: Params$Resource$Customers$Devices$Move, + options?: MethodOptions + ): GaxiosPromise; + move( + params: Params$Resource$Customers$Devices$Move, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + move( + params: Params$Resource$Customers$Devices$Move, + callback: BodyResponseCallback + ): void; + move(callback: BodyResponseCallback): void; + move( + paramsOrCallback?: + | Params$Resource$Customers$Devices$Move + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customers$Devices$Move; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Devices$Move; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}:move').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * prod_tt_sasportal.customers.devices.patch + * @desc Updates a device. + * @alias prod_tt_sasportal.customers.devices.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Output only. The resource path name. + * @param {string=} params.updateMask Fields to be updated. + * @param {().SasPortalDevice} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Customers$Devices$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Customers$Devices$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Customers$Devices$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Customers$Devices$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customers$Devices$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Devices$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * prod_tt_sasportal.customers.devices.signDevice + * @desc Signs a device. + * @alias prod_tt_sasportal.customers.devices.signDevice + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Output only. The resource path name. + * @param {().SasPortalSignDeviceRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + signDevice( + params?: Params$Resource$Customers$Devices$Signdevice, + options?: MethodOptions + ): GaxiosPromise; + signDevice( + params: Params$Resource$Customers$Devices$Signdevice, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + signDevice( + params: Params$Resource$Customers$Devices$Signdevice, + callback: BodyResponseCallback + ): void; + signDevice(callback: BodyResponseCallback): void; + signDevice( + paramsOrCallback?: + | Params$Resource$Customers$Devices$Signdevice + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customers$Devices$Signdevice; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Devices$Signdevice; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}:signDevice').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * prod_tt_sasportal.customers.devices.updateSigned + * @desc Updates a signed device. + * @alias prod_tt_sasportal.customers.devices.updateSigned + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the device to update. + * @param {().SasPortalUpdateSignedDeviceRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + updateSigned( + params?: Params$Resource$Customers$Devices$Updatesigned, + options?: MethodOptions + ): GaxiosPromise; + updateSigned( + params: Params$Resource$Customers$Devices$Updatesigned, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateSigned( + params: Params$Resource$Customers$Devices$Updatesigned, + callback: BodyResponseCallback + ): void; + updateSigned(callback: BodyResponseCallback): void; + updateSigned( + paramsOrCallback?: + | Params$Resource$Customers$Devices$Updatesigned + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customers$Devices$Updatesigned; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Devices$Updatesigned; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}:updateSigned').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Customers$Devices$Bulk + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the parent resource. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalBulkCreateDeviceRequest; + } + export interface Params$Resource$Customers$Devices$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the parent resource. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalDevice; + } + export interface Params$Resource$Customers$Devices$Createsigned + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the parent resource. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalCreateSignedDeviceRequest; + } + export interface Params$Resource$Customers$Devices$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the device. + */ + name?: string; + } + export interface Params$Resource$Customers$Devices$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the device. + */ + name?: string; + } + export interface Params$Resource$Customers$Devices$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The filter expression. The filter should have one of the following formats: "sn=123454" or "display_name=MyDevice". sn corresponds to serial_number of the device. The filter is case insensitive. + */ + filter?: string; + /** + * The maximum number of devices to return in the response. + */ + pageSize?: number; + /** + * A pagination token returned from a previous call to ListDevices that indicates where this listing should continue from. + */ + pageToken?: string; + /** + * Required. The name of the parent resource. + */ + parent?: string; + } + export interface Params$Resource$Customers$Devices$Move + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the device to move. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalMoveDeviceRequest; + } + export interface Params$Resource$Customers$Devices$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Output only. The resource path name. + */ + name?: string; + /** + * Fields to be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalDevice; + } + export interface Params$Resource$Customers$Devices$Signdevice + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Output only. The resource path name. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalSignDeviceRequest; + } + export interface Params$Resource$Customers$Devices$Updatesigned + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the device to update. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalUpdateSignedDeviceRequest; + } + + export class Resource$Customers$Nodes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * prod_tt_sasportal.customers.nodes.create + * @desc Creates a new node. + * @alias prod_tt_sasportal.customers.nodes.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The parent resource name where the node is to be created. + * @param {().SasPortalNode} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params?: Params$Resource$Customers$Nodes$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Customers$Nodes$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Customers$Nodes$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Customers$Nodes$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customers$Nodes$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Nodes$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/nodes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * prod_tt_sasportal.customers.nodes.delete + * @desc Deletes a node. + * @alias prod_tt_sasportal.customers.nodes.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the node. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Customers$Nodes$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Customers$Nodes$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Customers$Nodes$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Customers$Nodes$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customers$Nodes$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Nodes$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * prod_tt_sasportal.customers.nodes.get + * @desc Returns a requested node. + * @alias prod_tt_sasportal.customers.nodes.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the node. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Customers$Nodes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Customers$Nodes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Customers$Nodes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Customers$Nodes$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customers$Nodes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Nodes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * prod_tt_sasportal.customers.nodes.list + * @desc Lists nodes. + * @alias prod_tt_sasportal.customers.nodes.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize The maximum number of nodes to return in the response. + * @param {string=} params.pageToken A pagination token returned from a previous call to ListNodes method that indicates where this listing should continue from. + * @param {string} params.parent Required. The parent resource name, for example, "nodes/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 + */ + list( + params?: Params$Resource$Customers$Nodes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Customers$Nodes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Customers$Nodes$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Customers$Nodes$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customers$Nodes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Nodes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/nodes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * prod_tt_sasportal.customers.nodes.move + * @desc Moves a node under another node or customer. + * @alias prod_tt_sasportal.customers.nodes.move + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the node to move. + * @param {().SasPortalMoveNodeRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + move( + params?: Params$Resource$Customers$Nodes$Move, + options?: MethodOptions + ): GaxiosPromise; + move( + params: Params$Resource$Customers$Nodes$Move, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + move( + params: Params$Resource$Customers$Nodes$Move, + callback: BodyResponseCallback + ): void; + move(callback: BodyResponseCallback): void; + move( + paramsOrCallback?: + | Params$Resource$Customers$Nodes$Move + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customers$Nodes$Move; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Nodes$Move; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}:move').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * prod_tt_sasportal.customers.nodes.patch + * @desc Updates an existing node. + * @alias prod_tt_sasportal.customers.nodes.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Output only. Resource name. + * @param {string=} params.updateMask Fields to be updated. + * @param {().SasPortalNode} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Customers$Nodes$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Customers$Nodes$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Customers$Nodes$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Customers$Nodes$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customers$Nodes$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Nodes$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Customers$Nodes$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The parent resource name where the node is to be created. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalNode; + } + export interface Params$Resource$Customers$Nodes$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the node. + */ + name?: string; + } + export interface Params$Resource$Customers$Nodes$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the node. + */ + name?: string; + } + export interface Params$Resource$Customers$Nodes$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The maximum number of nodes to return in the response. + */ + pageSize?: number; + /** + * A pagination token returned from a previous call to ListNodes method that indicates where this listing should continue from. + */ + pageToken?: string; + /** + * Required. The parent resource name, for example, "nodes/1". + */ + parent?: string; + } + export interface Params$Resource$Customers$Nodes$Move + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the node to move. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalMoveNodeRequest; + } + export interface Params$Resource$Customers$Nodes$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Output only. Resource name. + */ + name?: string; + /** + * Fields to be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalNode; + } + + export class Resource$Installer { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * prod_tt_sasportal.installer.generateSecret + * @desc Generates a secret to be used with the ValidateInstaller method + * @alias prod_tt_sasportal.installer.generateSecret + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().SasPortalGenerateSecretRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + generateSecret( + params?: Params$Resource$Installer$Generatesecret, + options?: MethodOptions + ): GaxiosPromise; + generateSecret( + params: Params$Resource$Installer$Generatesecret, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateSecret( + params: Params$Resource$Installer$Generatesecret, + callback: BodyResponseCallback + ): void; + generateSecret( + callback: BodyResponseCallback + ): void; + generateSecret( + paramsOrCallback?: + | Params$Resource$Installer$Generatesecret + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Installer$Generatesecret; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Installer$Generatesecret; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/installer:generateSecret').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * prod_tt_sasportal.installer.validate + * @desc Validates the identity of a Certified Professional Installer (CPI). + * @alias prod_tt_sasportal.installer.validate + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().SasPortalValidateInstallerRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + validate( + params?: Params$Resource$Installer$Validate, + options?: MethodOptions + ): GaxiosPromise; + validate( + params: Params$Resource$Installer$Validate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + validate( + params: Params$Resource$Installer$Validate, + callback: BodyResponseCallback + ): void; + validate( + callback: BodyResponseCallback + ): void; + validate( + paramsOrCallback?: + | Params$Resource$Installer$Validate + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Installer$Validate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Installer$Validate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/installer:validate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Installer$Generatesecret + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalGenerateSecretRequest; + } + export interface Params$Resource$Installer$Validate + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalValidateInstallerRequest; + } + + export class Resource$Nodes { + context: APIRequestContext; + devices: Resource$Nodes$Devices; + nodes: Resource$Nodes$Nodes; + constructor(context: APIRequestContext) { + this.context = context; + this.devices = new Resource$Nodes$Devices(this.context); + this.nodes = new Resource$Nodes$Nodes(this.context); + } + } + + export class Resource$Nodes$Devices { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * prod_tt_sasportal.nodes.devices.bulk + * @desc Creates a device under a node or customer. Returned devices are unordered. + * @alias prod_tt_sasportal.nodes.devices.bulk + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The name of the parent resource. + * @param {().SasPortalBulkCreateDeviceRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + bulk( + params?: Params$Resource$Nodes$Devices$Bulk, + options?: MethodOptions + ): GaxiosPromise; + bulk( + params: Params$Resource$Nodes$Devices$Bulk, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulk( + params: Params$Resource$Nodes$Devices$Bulk, + callback: BodyResponseCallback + ): void; + bulk( + callback: BodyResponseCallback + ): void; + bulk( + paramsOrCallback?: + | Params$Resource$Nodes$Devices$Bulk + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodes$Devices$Bulk; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodes$Devices$Bulk; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/devices:bulk').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * prod_tt_sasportal.nodes.devices.create + * @desc Creates a device under a node or customer. + * @alias prod_tt_sasportal.nodes.devices.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The name of the parent resource. + * @param {().SasPortalDevice} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params?: Params$Resource$Nodes$Devices$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Nodes$Devices$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Nodes$Devices$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Nodes$Devices$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodes$Devices$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodes$Devices$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/devices').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * prod_tt_sasportal.nodes.devices.createSigned + * @desc Creates a signed device under a node or customer. + * @alias prod_tt_sasportal.nodes.devices.createSigned + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The name of the parent resource. + * @param {().SasPortalCreateSignedDeviceRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + createSigned( + params?: Params$Resource$Nodes$Devices$Createsigned, + options?: MethodOptions + ): GaxiosPromise; + createSigned( + params: Params$Resource$Nodes$Devices$Createsigned, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + createSigned( + params: Params$Resource$Nodes$Devices$Createsigned, + callback: BodyResponseCallback + ): void; + createSigned(callback: BodyResponseCallback): void; + createSigned( + paramsOrCallback?: + | Params$Resource$Nodes$Devices$Createsigned + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodes$Devices$Createsigned; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodes$Devices$Createsigned; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/devices:createSigned').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * prod_tt_sasportal.nodes.devices.delete + * @desc Deletes a device. + * @alias prod_tt_sasportal.nodes.devices.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the device. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Nodes$Devices$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Nodes$Devices$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Nodes$Devices$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Nodes$Devices$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodes$Devices$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodes$Devices$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * prod_tt_sasportal.nodes.devices.get + * @desc Gets details about a device. + * @alias prod_tt_sasportal.nodes.devices.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the device. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Nodes$Devices$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Nodes$Devices$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Nodes$Devices$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Nodes$Devices$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodes$Devices$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodes$Devices$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * prod_tt_sasportal.nodes.devices.list + * @desc Lists devices under a node or customer. + * @alias prod_tt_sasportal.nodes.devices.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter The filter expression. The filter should have one of the following formats: "sn=123454" or "display_name=MyDevice". sn corresponds to serial_number of the device. The filter is case insensitive. + * @param {integer=} params.pageSize The maximum number of devices to return in the response. + * @param {string=} params.pageToken A pagination token returned from a previous call to ListDevices that indicates where this listing should continue from. + * @param {string} params.parent Required. The name of the parent 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 + */ + list( + params?: Params$Resource$Nodes$Devices$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Nodes$Devices$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Nodes$Devices$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Nodes$Devices$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodes$Devices$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodes$Devices$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/devices').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * prod_tt_sasportal.nodes.devices.move + * @desc Moves a device under another node or customer. + * @alias prod_tt_sasportal.nodes.devices.move + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the device to move. + * @param {().SasPortalMoveDeviceRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + move( + params?: Params$Resource$Nodes$Devices$Move, + options?: MethodOptions + ): GaxiosPromise; + move( + params: Params$Resource$Nodes$Devices$Move, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + move( + params: Params$Resource$Nodes$Devices$Move, + callback: BodyResponseCallback + ): void; + move(callback: BodyResponseCallback): void; + move( + paramsOrCallback?: + | Params$Resource$Nodes$Devices$Move + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodes$Devices$Move; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodes$Devices$Move; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}:move').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * prod_tt_sasportal.nodes.devices.patch + * @desc Updates a device. + * @alias prod_tt_sasportal.nodes.devices.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Output only. The resource path name. + * @param {string=} params.updateMask Fields to be updated. + * @param {().SasPortalDevice} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Nodes$Devices$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Nodes$Devices$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Nodes$Devices$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Nodes$Devices$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodes$Devices$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodes$Devices$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * prod_tt_sasportal.nodes.devices.signDevice + * @desc Signs a device. + * @alias prod_tt_sasportal.nodes.devices.signDevice + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Output only. The resource path name. + * @param {().SasPortalSignDeviceRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + signDevice( + params?: Params$Resource$Nodes$Devices$Signdevice, + options?: MethodOptions + ): GaxiosPromise; + signDevice( + params: Params$Resource$Nodes$Devices$Signdevice, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + signDevice( + params: Params$Resource$Nodes$Devices$Signdevice, + callback: BodyResponseCallback + ): void; + signDevice(callback: BodyResponseCallback): void; + signDevice( + paramsOrCallback?: + | Params$Resource$Nodes$Devices$Signdevice + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodes$Devices$Signdevice; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodes$Devices$Signdevice; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}:signDevice').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * prod_tt_sasportal.nodes.devices.updateSigned + * @desc Updates a signed device. + * @alias prod_tt_sasportal.nodes.devices.updateSigned + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the device to update. + * @param {().SasPortalUpdateSignedDeviceRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + updateSigned( + params?: Params$Resource$Nodes$Devices$Updatesigned, + options?: MethodOptions + ): GaxiosPromise; + updateSigned( + params: Params$Resource$Nodes$Devices$Updatesigned, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateSigned( + params: Params$Resource$Nodes$Devices$Updatesigned, + callback: BodyResponseCallback + ): void; + updateSigned(callback: BodyResponseCallback): void; + updateSigned( + paramsOrCallback?: + | Params$Resource$Nodes$Devices$Updatesigned + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodes$Devices$Updatesigned; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodes$Devices$Updatesigned; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}:updateSigned').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Nodes$Devices$Bulk + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the parent resource. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalBulkCreateDeviceRequest; + } + export interface Params$Resource$Nodes$Devices$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the parent resource. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalDevice; + } + export interface Params$Resource$Nodes$Devices$Createsigned + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the parent resource. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalCreateSignedDeviceRequest; + } + export interface Params$Resource$Nodes$Devices$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the device. + */ + name?: string; + } + export interface Params$Resource$Nodes$Devices$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the device. + */ + name?: string; + } + export interface Params$Resource$Nodes$Devices$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The filter expression. The filter should have one of the following formats: "sn=123454" or "display_name=MyDevice". sn corresponds to serial_number of the device. The filter is case insensitive. + */ + filter?: string; + /** + * The maximum number of devices to return in the response. + */ + pageSize?: number; + /** + * A pagination token returned from a previous call to ListDevices that indicates where this listing should continue from. + */ + pageToken?: string; + /** + * Required. The name of the parent resource. + */ + parent?: string; + } + export interface Params$Resource$Nodes$Devices$Move + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the device to move. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalMoveDeviceRequest; + } + export interface Params$Resource$Nodes$Devices$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Output only. The resource path name. + */ + name?: string; + /** + * Fields to be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalDevice; + } + export interface Params$Resource$Nodes$Devices$Signdevice + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Output only. The resource path name. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalSignDeviceRequest; + } + export interface Params$Resource$Nodes$Devices$Updatesigned + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the device to update. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalUpdateSignedDeviceRequest; + } + + export class Resource$Nodes$Nodes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * prod_tt_sasportal.nodes.nodes.create + * @desc Creates a new node. + * @alias prod_tt_sasportal.nodes.nodes.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The parent resource name where the node is to be created. + * @param {().SasPortalNode} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params?: Params$Resource$Nodes$Nodes$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Nodes$Nodes$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Nodes$Nodes$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Nodes$Nodes$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodes$Nodes$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodes$Nodes$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/nodes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * prod_tt_sasportal.nodes.nodes.delete + * @desc Deletes a node. + * @alias prod_tt_sasportal.nodes.nodes.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the node. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Nodes$Nodes$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Nodes$Nodes$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Nodes$Nodes$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Nodes$Nodes$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodes$Nodes$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodes$Nodes$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * prod_tt_sasportal.nodes.nodes.get + * @desc Returns a requested node. + * @alias prod_tt_sasportal.nodes.nodes.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the node. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Nodes$Nodes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Nodes$Nodes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Nodes$Nodes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Nodes$Nodes$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Nodes$Nodes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodes$Nodes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * prod_tt_sasportal.nodes.nodes.list + * @desc Lists nodes. + * @alias prod_tt_sasportal.nodes.nodes.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize The maximum number of nodes to return in the response. + * @param {string=} params.pageToken A pagination token returned from a previous call to ListNodes method that indicates where this listing should continue from. + * @param {string} params.parent Required. The parent resource name, for example, "nodes/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 + */ + list( + params?: Params$Resource$Nodes$Nodes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Nodes$Nodes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Nodes$Nodes$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Nodes$Nodes$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Nodes$Nodes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodes$Nodes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/nodes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * prod_tt_sasportal.nodes.nodes.move + * @desc Moves a node under another node or customer. + * @alias prod_tt_sasportal.nodes.nodes.move + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the node to move. + * @param {().SasPortalMoveNodeRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + move( + params?: Params$Resource$Nodes$Nodes$Move, + options?: MethodOptions + ): GaxiosPromise; + move( + params: Params$Resource$Nodes$Nodes$Move, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + move( + params: Params$Resource$Nodes$Nodes$Move, + callback: BodyResponseCallback + ): void; + move(callback: BodyResponseCallback): void; + move( + paramsOrCallback?: + | Params$Resource$Nodes$Nodes$Move + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Nodes$Nodes$Move; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodes$Nodes$Move; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}:move').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * prod_tt_sasportal.nodes.nodes.patch + * @desc Updates an existing node. + * @alias prod_tt_sasportal.nodes.nodes.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Output only. Resource name. + * @param {string=} params.updateMask Fields to be updated. + * @param {().SasPortalNode} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Nodes$Nodes$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Nodes$Nodes$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Nodes$Nodes$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Nodes$Nodes$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodes$Nodes$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodes$Nodes$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Nodes$Nodes$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The parent resource name where the node is to be created. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalNode; + } + export interface Params$Resource$Nodes$Nodes$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the node. + */ + name?: string; + } + export interface Params$Resource$Nodes$Nodes$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the node. + */ + name?: string; + } + export interface Params$Resource$Nodes$Nodes$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The maximum number of nodes to return in the response. + */ + pageSize?: number; + /** + * A pagination token returned from a previous call to ListNodes method that indicates where this listing should continue from. + */ + pageToken?: string; + /** + * Required. The parent resource name, for example, "nodes/1". + */ + parent?: string; + } + export interface Params$Resource$Nodes$Nodes$Move extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the node to move. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalMoveNodeRequest; + } + export interface Params$Resource$Nodes$Nodes$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Output only. Resource name. + */ + name?: string; + /** + * Fields to be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalNode; + } + + export class Resource$Policies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * prod_tt_sasportal.policies.get + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * @alias prod_tt_sasportal.policies.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().SasPortalGetPolicyRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Policies$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Policies$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Policies$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Policies$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Policies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Policies$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/policies:get').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * prod_tt_sasportal.policies.set + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @alias prod_tt_sasportal.policies.set + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().SasPortalSetPolicyRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + set( + params?: Params$Resource$Policies$Set, + options?: MethodOptions + ): GaxiosPromise; + set( + params: Params$Resource$Policies$Set, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + set( + params: Params$Resource$Policies$Set, + callback: BodyResponseCallback + ): void; + set(callback: BodyResponseCallback): void; + set( + paramsOrCallback?: + | Params$Resource$Policies$Set + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Policies$Set; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Policies$Set; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/policies:set').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * prod_tt_sasportal.policies.test + * @desc Returns permissions that a caller has on the specified resource. + * @alias prod_tt_sasportal.policies.test + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().SasPortalTestPermissionsRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + test( + params?: Params$Resource$Policies$Test, + options?: MethodOptions + ): GaxiosPromise; + test( + params: Params$Resource$Policies$Test, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + test( + params: Params$Resource$Policies$Test, + callback: BodyResponseCallback + ): void; + test( + callback: BodyResponseCallback + ): void; + test( + paramsOrCallback?: + | Params$Resource$Policies$Test + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Policies$Test; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Policies$Test; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://prod-tt-sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/policies:test').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Policies$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalGetPolicyRequest; + } + export interface Params$Resource$Policies$Set extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalSetPolicyRequest; + } + export interface Params$Resource$Policies$Test extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalTestPermissionsRequest; + } +} diff --git a/src/apis/fusiontables/webpack.config.js b/src/apis/prod_tt_sasportal/webpack.config.js similarity index 95% rename from src/apis/fusiontables/webpack.config.js rename to src/apis/prod_tt_sasportal/webpack.config.js index 6dca1cdc75d..c7a63553b98 100644 --- a/src/apis/fusiontables/webpack.config.js +++ b/src/apis/prod_tt_sasportal/webpack.config.js @@ -22,8 +22,8 @@ module.exports = { extensions: ['.ts', '.js', '.json'], }, output: { - library: 'Fusiontables', - filename: 'fusiontables.min.js', + library: 'Prod_tt_sasportal', + filename: 'prod_tt_sasportal.min.js', path: path.resolve(__dirname, 'dist'), }, node: { diff --git a/src/apis/pubsub/v1.ts b/src/apis/pubsub/v1.ts index 790ec2d358f..5fa9896a105 100644 --- a/src/apis/pubsub/v1.ts +++ b/src/apis/pubsub/v1.ts @@ -133,7 +133,7 @@ export namespace pubsub_v1 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -295,19 +295,19 @@ export namespace pubsub_v1 { serviceAccountEmail?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if the incoming policy version does not meet the requirements for modifying the stored policy. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a binding (conditional or unconditional) from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, version compliance checks against the stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } diff --git a/src/apis/pubsub/v1beta2.ts b/src/apis/pubsub/v1beta2.ts index 5cc5389412b..abffd0e507a 100644 --- a/src/apis/pubsub/v1beta2.ts +++ b/src/apis/pubsub/v1beta2.ts @@ -133,7 +133,7 @@ export namespace pubsub_v1beta2 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -245,19 +245,19 @@ export namespace pubsub_v1beta2 { serviceAccountEmail?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if the incoming policy version does not meet the requirements for modifying the stored policy. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a binding (conditional or unconditional) from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, version compliance checks against the stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } diff --git a/src/apis/recommender/v1beta1.ts b/src/apis/recommender/v1beta1.ts index 2d2ebe6b28a..257439a6fd9 100644 --- a/src/apis/recommender/v1beta1.ts +++ b/src/apis/recommender/v1beta1.ts @@ -159,11 +159,11 @@ export namespace recommender_v1beta1 { */ export interface Schema$GoogleCloudRecommenderV1beta1MarkRecommendationClaimedRequest { /** - * Fingerprint of the Recommendation. Provides optimistic locking. + * Required. Fingerprint of the Recommendation. Provides optimistic locking. */ etag?: string | null; /** - * State properties to include with this state. Overwrites any existing `state_metadata`. + * State properties to include with this state. Overwrites any existing `state_metadata`. Keys must match the regex /^a-z0-9{0,62}$/. Values must match the regex /^[a-zA-Z0-9_./-]{0,255}$/. */ stateMetadata?: {[key: string]: string} | null; } @@ -172,11 +172,11 @@ export namespace recommender_v1beta1 { */ export interface Schema$GoogleCloudRecommenderV1beta1MarkRecommendationFailedRequest { /** - * Fingerprint of the Recommendation. Provides optimistic locking. + * Required. Fingerprint of the Recommendation. Provides optimistic locking. */ etag?: string | null; /** - * State properties to include with this state. Overwrites any existing `state_metadata`. + * State properties to include with this state. Overwrites any existing `state_metadata`. Keys must match the regex /^a-z0-9{0,62}$/. Values must match the regex /^[a-zA-Z0-9_./-]{0,255}$/. */ stateMetadata?: {[key: string]: string} | null; } @@ -185,11 +185,11 @@ export namespace recommender_v1beta1 { */ export interface Schema$GoogleCloudRecommenderV1beta1MarkRecommendationSucceededRequest { /** - * Fingerprint of the Recommendation. Provides optimistic locking. + * Required. Fingerprint of the Recommendation. Provides optimistic locking. */ etag?: string | null; /** - * State properties to include with this state. Overwrites any existing `state_metadata`. + * State properties to include with this state. Overwrites any existing `state_metadata`. Keys must match the regex /^a-z0-9{0,62}$/. Values must match the regex /^[a-zA-Z0-9_./-]{0,255}$/. */ stateMetadata?: {[key: string]: string} | null; } @@ -274,7 +274,7 @@ export namespace recommender_v1beta1 { */ lastRefreshTime?: string | null; /** - * Name of recommendation. A project recommendation is represented as projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID] + * Name of recommendation. */ name?: string | null; /** @@ -383,7 +383,7 @@ export namespace recommender_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Name of the recommendation. + * @param {string} params.name Required. Name of the recommendation. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -480,7 +480,7 @@ export namespace recommender_v1beta1 { * * @param {object} params Parameters for request * @param {string=} params.filter Filter expression to restrict the recommendations returned. Supported filter fields: state_info.state Eg: `state_info.state:"DISMISSED" or state_info.state:"FAILED" - * @param {integer=} params.pageSize Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return. + * @param {integer=} params.pageSize Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return. * @param {string=} params.pageToken Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call. * @param {string} params.parent Required. The container resource on which to execute the request. Acceptable formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -582,7 +582,7 @@ export namespace recommender_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Name of the recommendation. + * @param {string} params.name Required. Name of the recommendation. * @param {().GoogleCloudRecommenderV1beta1MarkRecommendationClaimedRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -682,7 +682,7 @@ export namespace recommender_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Name of the recommendation. + * @param {string} params.name Required. Name of the recommendation. * @param {().GoogleCloudRecommenderV1beta1MarkRecommendationFailedRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -782,7 +782,7 @@ export namespace recommender_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Name of the recommendation. + * @param {string} params.name Required. Name of the recommendation. * @param {().GoogleCloudRecommenderV1beta1MarkRecommendationSucceededRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -884,7 +884,7 @@ export namespace recommender_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the recommendation. + * Required. Name of the recommendation. */ name?: string; } @@ -900,7 +900,7 @@ export namespace recommender_v1beta1 { */ filter?: string; /** - * Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return. + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return. */ pageSize?: number; /** @@ -920,7 +920,7 @@ export namespace recommender_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the recommendation. + * Required. Name of the recommendation. */ name?: string; @@ -937,7 +937,7 @@ export namespace recommender_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the recommendation. + * Required. Name of the recommendation. */ name?: string; @@ -954,7 +954,7 @@ export namespace recommender_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the recommendation. + * Required. Name of the recommendation. */ name?: string; diff --git a/src/apis/redis/v1.ts b/src/apis/redis/v1.ts index c4266055dd7..c6f42bfd75a 100644 --- a/src/apis/redis/v1.ts +++ b/src/apis/redis/v1.ts @@ -278,7 +278,7 @@ export namespace redis_v1 { */ redisConfigs?: {[key: string]: string} | null; /** - * Optional. The version of Redis software. If not provided, latest supported version will be used. Updating the version will perform an upgrade/downgrade to the new version. Currently, the supported values are: * `REDIS_4_0` for Redis 4.0 compatibility (default) * `REDIS_3_2` for Redis 3.2 compatibility + * Optional. The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: * `REDIS_4_0` for Redis 4.0 compatibility (default) * `REDIS_3_2` for Redis 3.2 compatibility */ redisVersion?: string | null; /** diff --git a/src/apis/redis/v1beta1.ts b/src/apis/redis/v1beta1.ts index 3dbb5948f8a..2e83dc5b687 100644 --- a/src/apis/redis/v1beta1.ts +++ b/src/apis/redis/v1beta1.ts @@ -278,7 +278,7 @@ export namespace redis_v1beta1 { */ redisConfigs?: {[key: string]: string} | null; /** - * Optional. The version of Redis software. If not provided, latest supported version will be used. Updating the version will perform an upgrade/downgrade to the new version. Currently, the supported values are: * `REDIS_4_0` for Redis 4.0 compatibility (default) * `REDIS_3_2` for Redis 3.2 compatibility + * Optional. The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: * `REDIS_4_0` for Redis 4.0 compatibility (default) * `REDIS_3_2` for Redis 3.2 compatibility */ redisVersion?: string | null; /** diff --git a/src/apis/remotebuildexecution/v1.ts b/src/apis/remotebuildexecution/v1.ts index ea6f6b5d810..84bb278d208 100644 --- a/src/apis/remotebuildexecution/v1.ts +++ b/src/apis/remotebuildexecution/v1.ts @@ -614,6 +614,18 @@ export namespace remotebuildexecution_v1 { */ message?: string | null; } + /** + * ResourceUsage is the system resource usage of the host machine. + */ + export interface Schema$GoogleDevtoolsRemotebuildbotResourceUsage { + cpuUsedPercent?: number | null; + diskUsage?: Schema$GoogleDevtoolsRemotebuildbotResourceUsageStat; + memoryUsage?: Schema$GoogleDevtoolsRemotebuildbotResourceUsageStat; + } + export interface Schema$GoogleDevtoolsRemotebuildbotResourceUsageStat { + total?: string | null; + used?: string | null; + } /** * AcceleratorConfig defines the accelerator cards to attach to the VM. */ @@ -789,7 +801,7 @@ export namespace remotebuildexecution_v1 { */ diskSizeGb?: string | null; /** - * Required. Disk Type to use for the worker. See [Storage options](https://cloud.google.com/compute/docs/disks/#introduction). Currently only `pd-standard` is supported. + * Required. Disk Type to use for the worker. See [Storage options](https://cloud.google.com/compute/docs/disks/#introduction). Currently only `pd-standard` and `pd-ssd` are supported. */ diskType?: string | null; /** diff --git a/src/apis/remotebuildexecution/v1alpha.ts b/src/apis/remotebuildexecution/v1alpha.ts index 17e05e1bea6..2055c971193 100644 --- a/src/apis/remotebuildexecution/v1alpha.ts +++ b/src/apis/remotebuildexecution/v1alpha.ts @@ -601,6 +601,18 @@ export namespace remotebuildexecution_v1alpha { */ message?: string | null; } + /** + * ResourceUsage is the system resource usage of the host machine. + */ + export interface Schema$GoogleDevtoolsRemotebuildbotResourceUsage { + cpuUsedPercent?: number | null; + diskUsage?: Schema$GoogleDevtoolsRemotebuildbotResourceUsageStat; + memoryUsage?: Schema$GoogleDevtoolsRemotebuildbotResourceUsageStat; + } + export interface Schema$GoogleDevtoolsRemotebuildbotResourceUsageStat { + total?: string | null; + used?: string | null; + } /** * AcceleratorConfig defines the accelerator cards to attach to the VM. */ @@ -776,7 +788,7 @@ export namespace remotebuildexecution_v1alpha { */ diskSizeGb?: string | null; /** - * Required. Disk Type to use for the worker. See [Storage options](https://cloud.google.com/compute/docs/disks/#introduction). Currently only `pd-standard` is supported. + * Required. Disk Type to use for the worker. See [Storage options](https://cloud.google.com/compute/docs/disks/#introduction). Currently only `pd-standard` and `pd-ssd` are supported. */ diskType?: string | null; /** diff --git a/src/apis/remotebuildexecution/v2.ts b/src/apis/remotebuildexecution/v2.ts index 4051b81e90d..12c1ea826e8 100644 --- a/src/apis/remotebuildexecution/v2.ts +++ b/src/apis/remotebuildexecution/v2.ts @@ -869,6 +869,18 @@ export namespace remotebuildexecution_v2 { */ message?: string | null; } + /** + * ResourceUsage is the system resource usage of the host machine. + */ + export interface Schema$GoogleDevtoolsRemotebuildbotResourceUsage { + cpuUsedPercent?: number | null; + diskUsage?: Schema$GoogleDevtoolsRemotebuildbotResourceUsageStat; + memoryUsage?: Schema$GoogleDevtoolsRemotebuildbotResourceUsageStat; + } + export interface Schema$GoogleDevtoolsRemotebuildbotResourceUsageStat { + total?: string | null; + used?: string | null; + } /** * AcceleratorConfig defines the accelerator cards to attach to the VM. */ @@ -1044,7 +1056,7 @@ export namespace remotebuildexecution_v2 { */ diskSizeGb?: string | null; /** - * Required. Disk Type to use for the worker. See [Storage options](https://cloud.google.com/compute/docs/disks/#introduction). Currently only `pd-standard` is supported. + * Required. Disk Type to use for the worker. See [Storage options](https://cloud.google.com/compute/docs/disks/#introduction). Currently only `pd-standard` and `pd-ssd` are supported. */ diskType?: string | null; /** diff --git a/src/apis/run/v1.ts b/src/apis/run/v1.ts index 59fe6c5fc9c..cba5c2d1789 100644 --- a/src/apis/run/v1.ts +++ b/src/apis/run/v1.ts @@ -171,7 +171,7 @@ export namespace run_v1 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -927,7 +927,7 @@ export namespace run_v1 { uid?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -935,15 +935,15 @@ export namespace run_v1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if the incoming policy version does not meet the requirements for modifying the stored policy. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a binding (conditional or unconditional) from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, version compliance checks against the stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } diff --git a/src/apis/run/v1alpha1.ts b/src/apis/run/v1alpha1.ts index 980cb58cdf5..c262e82f9c4 100644 --- a/src/apis/run/v1alpha1.ts +++ b/src/apis/run/v1alpha1.ts @@ -175,7 +175,7 @@ export namespace run_v1alpha1 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -196,6 +196,86 @@ export namespace run_v1alpha1 { */ drop?: string[] | null; } + export interface Schema$CloudAuditLog { + /** + * The API version for this call such as "events.cloud.google.com/v1alpha1". + */ + apiVersion?: string | null; + /** + * The kind of resource, in this case "CloudAuditLog". + */ + kind?: string | null; + /** + * Metadata associated with this CloudAuditLog. + */ + metadata?: Schema$ObjectMeta; + /** + * Spec defines the desired state of the CloudAuditLog. + */ + spec?: Schema$CloudAuditLogSpec; + /** + * Status represents the current state of the CloudAuditLog. This data may be out of date. +optional + */ + status?: Schema$CloudAuditLogStatus; + } + /** + * The desired state of the CloudAuditLog. + */ + export interface Schema$CloudAuditLogSpec { + /** + * CloudEventOverrides defines overrides to control the output format and modifications of the event sent to the sink. +optional + */ + ceOverrides?: Schema$CloudEventOverrides; + /** + * Required. The method name at the service API. This must match "methodName" in Cloud Audit Logs. Regex or Wildcards (*) are not supported. Example: "google.cloud.bigquery.job.create". + */ + methodName?: string | null; + /** + * Project is the ID of the Google Cloud Project that the PubSub Topic exists in. If omitted, defaults to same as the cluster. +optional + */ + project?: string | null; + /** + * PubSubSecret is the credential to use to create Topic / PullSubscription resources. If omitted, uses Secret. + */ + pubsubSecret?: Schema$SecretKeySelector; + /** + * Optional. The resource specification. This must match "methodName" in Cloud Audit Logs. Regex or Wildcards (*) are not supported. Example: "projects/my-project/jobs/foo". + */ + resourceName?: string | null; + /** + * Secret is the credential to use to create the Scheduler Job. If not specified, defaults to: Name: google-cloud-key Key: key.json +optional + */ + secret?: Schema$SecretKeySelector; + /** + * Email address of the IAM service account associated with the source. The service account represents the identity of the source, and determines what permissions the source has. If not provided, the source will use the project's default service account. +optional + */ + serviceAccountName?: string | null; + /** + * Required. The GCP service name. This must match "serviceName" in Cloud Audit Logs. Regex or Wildcards (*) are not supported. Example: "bigquery.googleapis.com". + */ + serviceName?: string | null; + /** + * Sink is a reference to an object that will resolve to a domain name or a URI directly to use as the sink. + */ + sink?: Schema$Destination; + } + /** + * CloudAuditLogStatus represents the current state of a CloudAuditLog. + */ + export interface Schema$CloudAuditLogStatus { + /** + * Array of observed CloudAuditLogConditions, indicating the current state of the CloudAuditLog. + */ + conditions?: Schema$Condition[]; + /** + * ObservedGeneration is the 'Generation' of the CloudAuditLog that was last processed by the controller. + */ + observedGeneration?: number | null; + /** + * SinkURI is the current active sink URI that has been configured for the Source. +optional + */ + sinkUri?: string | null; + } /** * CloudEventOverrides defines arguments for a Source that control the output format of the CloudEvents produced by the Source. */ @@ -883,6 +963,31 @@ export namespace run_v1alpha1 { */ nextPageToken?: string | null; } + /** + * ListCloudAuditLogsResponse is a list of CloudAuditLog resources. + */ + export interface Schema$ListCloudAuditLogsResponse { + /** + * The API version for this call such as "events.cloud.google.com/v1alpha1". + */ + apiVersion?: string | null; + /** + * List of CloudAuditLogs. + */ + items?: Schema$CloudAuditLog[]; + /** + * The kind of this resource, in this case "CloudAuditLogList". + */ + kind?: string | null; + /** + * Metadata associated with this CloudAuditLog list. + */ + metadata?: Schema$ListMeta; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } /** * ListConfigurationsResponse is a list of Configuration resources. */ @@ -1088,6 +1193,31 @@ export namespace run_v1alpha1 { */ unreachable?: string[] | null; } + /** + * ListStoragesResponse is a list of Storage resources. + */ + export interface Schema$ListStoragesResponse { + /** + * The API version for this call such as "events.cloud.google.com/v1alpha1". + */ + apiVersion?: string | null; + /** + * List of Storages. + */ + items?: Schema$Storage[]; + /** + * The kind of this resource, in this case "StorageList". + */ + kind?: string | null; + /** + * Metadata associated with this Storage list. + */ + metadata?: Schema$ListMeta; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } /** * ListTriggersResponse is a list of Trigger resources. */ @@ -1279,7 +1409,7 @@ export namespace run_v1alpha1 { uid?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -1287,15 +1417,15 @@ export namespace run_v1alpha1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if the incoming policy version does not meet the requirements for modifying the stored policy. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a binding (conditional or unconditional) from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, version compliance checks against the stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } @@ -1382,6 +1512,10 @@ export namespace run_v1alpha1 { * Secret is the credential to use to create the Scheduler Job. If not specified, defaults to: Name: google-cloud-key Key: key.json +optional */ secret?: Schema$SecretKeySelector; + /** + * Email address of the IAM service account associated with the source. The service account represents the identity of the source, and determines what permissions the source has. If not provided, the source will use the project's Compute Engine default service account. +optional + */ + serviceAccountName?: string | null; /** * Sink is a reference to an object that will resolve to a domain name or a URI directly to use as the sink. */ @@ -1982,6 +2116,86 @@ export namespace run_v1alpha1 { */ updateMask?: string | null; } + export interface Schema$Storage { + /** + * The API version for this call such as "events.cloud.google.com/v1alpha1". + */ + apiVersion?: string | null; + /** + * The kind of resource, in this case "Storage". + */ + kind?: string | null; + /** + * Metadata associated with this Storage. + */ + metadata?: Schema$ObjectMeta; + /** + * Spec defines the desired state of the Storage. + */ + spec?: Schema$StorageSpec; + /** + * Status represents the current state of the Storage. This data may be out of date. +optional + */ + status?: Schema$StorageStatus; + } + /** + * The desired state of the Storage. + */ + export interface Schema$StorageSpec { + /** + * Bucket to subscribe to. + */ + bucket?: string | null; + /** + * CloudEventOverrides defines overrides to control the output format and modifications of the event sent to the sink. +optional + */ + ceOverrides?: Schema$CloudEventOverrides; + /** + * EventTypes to subscribe to. If unspecified, then subscribe to all events. +optional + */ + eventTypes?: string[] | null; + /** + * ObjectNamePrefix limits the notifications to objects with this prefix +optional + */ + objectNamePrefix?: string | null; + /** + * PayloadFormat specifies the contents of the message payload. See https://cloud.google.com/storage/docs/pubsub-notifications#payload. +optional + */ + payloadFormat?: string | null; + /** + * Project is the ID of the Google Cloud Project that the PubSub Topic exists in. If omitted, defaults to same as the cluster. +optional + */ + project?: string | null; + /** + * PubSubSecret is the credential to use to create Topic / PullSubscription resources. If omitted, uses Secret. + */ + pubsubSecret?: Schema$SecretKeySelector; + /** + * Secret is the credential to use to create the Scheduler Job. If not specified, defaults to: Name: google-cloud-key Key: key.json +optional + */ + secret?: Schema$SecretKeySelector; + /** + * ServiceAccountName holds the name of the Kubernetes service account as which the underlying K8s resources should be run. If unspecified this will default to the "default" service account for the namespace in which the GCS exists. +optional + */ + serviceAccountName?: string | null; + /** + * Sink is a reference to an object that will resolve to a domain name or a URI directly to use as the sink. + */ + sink?: Schema$Destination; + } + /** + * StorageStatus represents the current state of a Storage. + */ + export interface Schema$StorageStatus { + /** + * Array of observed StorageConditions, indicating the current state of the Storage. + */ + conditions?: Schema$Condition[]; + /** + * ObservedGeneration is the 'Generation' of the Storage that was last processed by the controller. + */ + observedGeneration?: number | null; + } export interface Schema$SubscriberSpec { /** * Reference to an object that will be used to find the target endpoint, which should implement the Addressable duck type. For example, this could be a reference to a Route resource or a Knative Service resource. @@ -2154,7 +2368,11 @@ export namespace run_v1alpha1 { */ importers?: Schema$TriggerImporterSpec[]; /** - * Subscriber is the addressable that receives events from the Broker that pass the Filter. It is required. E.g. https://us-central1-myproject.cloudfunctions.net/myfunction or /namespaces/my-project/services/my-service. + * Sink is the addressable that will receive events. + */ + sink?: Schema$Destination; + /** + * Deprecated, sink will be represented by Destination. Subscriber is the addressable that receives events from the Broker that pass the Filter. It is required. E.g. https://us-central1-myproject.cloudfunctions.net/myfunction or /namespaces/my-project/services/my-service. */ subscriber?: Schema$SubscriberSpec; } @@ -2228,6 +2446,7 @@ export namespace run_v1alpha1 { export class Resource$Namespaces { context: APIRequestContext; authorizeddomains: Resource$Namespaces$Authorizeddomains; + cloudauditlogs: Resource$Namespaces$Cloudauditlogs; configurations: Resource$Namespaces$Configurations; domainmappings: Resource$Namespaces$Domainmappings; eventtypes: Resource$Namespaces$Eventtypes; @@ -2235,12 +2454,16 @@ export namespace run_v1alpha1 { revisions: Resource$Namespaces$Revisions; routes: Resource$Namespaces$Routes; services: Resource$Namespaces$Services; + storages: Resource$Namespaces$Storages; triggers: Resource$Namespaces$Triggers; constructor(context: APIRequestContext) { this.context = context; this.authorizeddomains = new Resource$Namespaces$Authorizeddomains( this.context ); + this.cloudauditlogs = new Resource$Namespaces$Cloudauditlogs( + this.context + ); this.configurations = new Resource$Namespaces$Configurations( this.context ); @@ -2252,6 +2475,7 @@ export namespace run_v1alpha1 { this.revisions = new Resource$Namespaces$Revisions(this.context); this.routes = new Resource$Namespaces$Routes(this.context); this.services = new Resource$Namespaces$Services(this.context); + this.storages = new Resource$Namespaces$Storages(this.context); this.triggers = new Resource$Namespaces$Triggers(this.context); } } @@ -2369,54 +2593,55 @@ export namespace run_v1alpha1 { parent?: string; } - export class Resource$Namespaces$Configurations { + export class Resource$Namespaces$Cloudauditlogs { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * run.namespaces.configurations.get - * @desc Rpc to get information about a configuration. - * @alias run.namespaces.configurations.get + * run.namespaces.cloudauditlogs.create + * @desc Creates a new cloudauditlog. + * @alias run.namespaces.cloudauditlogs.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the configuration being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {string} params.parent The project ID or project number in which this cloudauditlog should be created. + * @param {().CloudAuditLog} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - get( - params?: Params$Resource$Namespaces$Configurations$Get, + create( + params?: Params$Resource$Namespaces$Cloudauditlogs$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Namespaces$Configurations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + create( + params: Params$Resource$Namespaces$Cloudauditlogs$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Namespaces$Configurations$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Namespaces$Cloudauditlogs$Create, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Namespaces$Configurations$Get - | BodyResponseCallback, + | Params$Resource$Namespaces$Cloudauditlogs$Create + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Configurations$Get; + {}) as Params$Resource$Namespaces$Cloudauditlogs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Configurations$Get; + params = {} as Params$Resource$Namespaces$Cloudauditlogs$Create; options = {}; } @@ -2430,77 +2655,68 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + '/apis/serving.knative.dev/v1alpha1/{+name}' + rootUrl + + '/apis/events.cloud.google.com/v1alpha1/{+parent}/cloudauditlogs' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.namespaces.configurations.list - * @desc Rpc to list configurations. - * @alias run.namespaces.configurations.list + * run.namespaces.cloudauditlogs.delete + * @desc Rpc to delete a cloudauditlog. + * @alias run.namespaces.cloudauditlogs.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.continue Optional encoded string to continue paging. - * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. - * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. - * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. - * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the configurations should be listed. - * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. - * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. + * @param {string=} params.kind Cloud Run currently ignores this parameter. + * @param {string} params.name The name of the cloudauditlog being deleted. If needed, replace {namespace_id} with the project ID. + * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - list( - params?: Params$Resource$Namespaces$Configurations$List, + delete( + params?: Params$Resource$Namespaces$Cloudauditlogs$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Namespaces$Configurations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Namespaces$Configurations$List, - callback: BodyResponseCallback + ): GaxiosPromise; + delete( + params: Params$Resource$Namespaces$Cloudauditlogs$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Namespaces$Cloudauditlogs$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Namespaces$Configurations$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Cloudauditlogs$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Configurations$List; + {}) as Params$Resource$Namespaces$Cloudauditlogs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Configurations$List; + params = {} as Params$Resource$Namespaces$Cloudauditlogs$Delete; options = {}; } @@ -2514,131 +2730,66 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + - '/apis/serving.knative.dev/v1alpha1/{+parent}/configurations' + rootUrl + '/apis/events.cloud.google.com/v1alpha1/{+name}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback - ); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Namespaces$Configurations$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the configuration being retrieved. If needed, replace {namespace_id} with the project ID. - */ - name?: string; - } - export interface Params$Resource$Namespaces$Configurations$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Optional encoded string to continue paging. - */ - continue?: string; - /** - * Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. - */ - fieldSelector?: string; - /** - * Not currently used by Cloud Run. - */ - includeUninitialized?: boolean; - /** - * Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. - */ - labelSelector?: string; - /** - * The maximum number of records that should be returned. - */ - limit?: number; - /** - * The project ID or project number from which the configurations should be listed. - */ - parent?: string; - /** - * The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. - */ - resourceVersion?: string; - /** - * Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. - */ - watch?: boolean; - } - - export class Resource$Namespaces$Domainmappings { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * run.namespaces.domainmappings.create - * @desc Creates a new domain mapping. - * @alias run.namespaces.domainmappings.create + * run.namespaces.cloudauditlogs.get + * @desc Rpc to get information about a cloudauditlog. + * @alias run.namespaces.cloudauditlogs.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The project ID or project number in which this domain mapping should be created. - * @param {().DomainMapping} params.requestBody Request body data + * @param {string} params.name The name of the cloudauditlog being retrieved. If needed, replace {namespace_id} with the project ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - create( - params?: Params$Resource$Namespaces$Domainmappings$Create, + get( + params?: Params$Resource$Namespaces$Cloudauditlogs$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Namespaces$Domainmappings$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + get( + params: Params$Resource$Namespaces$Cloudauditlogs$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Namespaces$Domainmappings$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Namespaces$Cloudauditlogs$Get, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Namespaces$Domainmappings$Create - | BodyResponseCallback, + | Params$Resource$Namespaces$Cloudauditlogs$Get + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Domainmappings$Create; + {}) as Params$Resource$Namespaces$Cloudauditlogs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Domainmappings$Create; + params = {} as Params$Resource$Namespaces$Cloudauditlogs$Get; options = {}; } @@ -2652,69 +2803,77 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + - '/apis/domains.cloudrun.com/v1alpha1/{+parent}/domainmappings' + rootUrl + '/apis/events.cloud.google.com/v1alpha1/{+name}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.namespaces.domainmappings.delete - * @desc Rpc to delete a domain mapping. - * @alias run.namespaces.domainmappings.delete + * run.namespaces.cloudauditlogs.list + * @desc Rpc to list cloudauditlogs. + * @alias run.namespaces.cloudauditlogs.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. - * @param {string=} params.kind Cloud Run currently ignores this parameter. - * @param {string} params.name The name of the domain mapping being deleted. If needed, replace {namespace_id} with the project ID. - * @param {boolean=} params.orphanDependents Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. - * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. + * @param {string=} params.continue Optional encoded string to continue paging. + * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. + * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + * @param {integer=} params.limit The maximum number of records that should be returned. + * @param {string} params.parent The project ID or project number from which the cloudauditlogs should be listed. + * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - delete( - params?: Params$Resource$Namespaces$Domainmappings$Delete, + list( + params?: Params$Resource$Namespaces$Cloudauditlogs$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Namespaces$Domainmappings$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + list( + params: Params$Resource$Namespaces$Cloudauditlogs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Namespaces$Domainmappings$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Namespaces$Cloudauditlogs$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Namespaces$Domainmappings$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Cloudauditlogs$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Domainmappings$Delete; + {}) as Params$Resource$Namespaces$Cloudauditlogs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Domainmappings$Delete; + params = {} as Params$Resource$Namespaces$Cloudauditlogs$List; options = {}; } @@ -2728,66 +2887,73 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + '/apis/domains.cloudrun.com/v1alpha1/{+name}' + rootUrl + + '/apis/events.cloud.google.com/v1alpha1/{+parent}/cloudauditlogs' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, + callback + ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.namespaces.domainmappings.get - * @desc Rpc to get information about a domain mapping. - * @alias run.namespaces.domainmappings.get + * run.namespaces.cloudauditlogs.replaceCloudAuditLog + * @desc Rpc to replace a cloudauditlog. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. + * @alias run.namespaces.cloudauditlogs.replaceCloudAuditLog * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the domain mapping being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {string} params.name The name of the cloudauditlog being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {().CloudAuditLog} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - get( - params?: Params$Resource$Namespaces$Domainmappings$Get, + replaceCloudAuditLog( + params?: Params$Resource$Namespaces$Cloudauditlogs$Replacecloudauditlog, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Namespaces$Domainmappings$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + replaceCloudAuditLog( + params: Params$Resource$Namespaces$Cloudauditlogs$Replacecloudauditlog, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Namespaces$Domainmappings$Get, - callback: BodyResponseCallback + replaceCloudAuditLog( + params: Params$Resource$Namespaces$Cloudauditlogs$Replacecloudauditlog, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + replaceCloudAuditLog( + callback: BodyResponseCallback + ): void; + replaceCloudAuditLog( paramsOrCallback?: - | Params$Resource$Namespaces$Domainmappings$Get - | BodyResponseCallback, + | Params$Resource$Namespaces$Cloudauditlogs$Replacecloudauditlog + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Domainmappings$Get; + {}) as Params$Resource$Namespaces$Cloudauditlogs$Replacecloudauditlog; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Domainmappings$Get; + params = {} as Params$Resource$Namespaces$Cloudauditlogs$Replacecloudauditlog; options = {}; } @@ -2801,9 +2967,9 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + '/apis/domains.cloudrun.com/v1alpha1/{+name}' + rootUrl + '/apis/events.cloud.google.com/v1alpha1/{+name}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PUT', }, options ), @@ -2813,119 +2979,31 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Namespaces$Cloudauditlogs$Create + extends StandardParameters { /** - * run.namespaces.domainmappings.list - * @desc Rpc to list domain mappings. - * @alias run.namespaces.domainmappings.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.continue Optional encoded string to continue paging. - * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. - * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. - * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. - * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the domain mappings should be listed. - * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. - * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object + * Auth client or API Key for the request */ - list( - params?: Params$Resource$Namespaces$Domainmappings$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Namespaces$Domainmappings$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Namespaces$Domainmappings$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Namespaces$Domainmappings$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Domainmappings$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Domainmappings$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/apis/domains.cloudrun.com/v1alpha1/{+parent}/domainmappings' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Namespaces$Domainmappings$Create - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project ID or project number in which this domain mapping should be created. + * The project ID or project number in which this cloudauditlog should be created. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$DomainMapping; + requestBody?: Schema$CloudAuditLog; } - export interface Params$Resource$Namespaces$Domainmappings$Delete + export interface Params$Resource$Namespaces$Cloudauditlogs$Delete extends StandardParameters { /** * Auth client or API Key for the request @@ -2941,19 +3019,15 @@ export namespace run_v1alpha1 { */ kind?: string; /** - * The name of the domain mapping being deleted. If needed, replace {namespace_id} with the project ID. + * The name of the cloudauditlog being deleted. If needed, replace {namespace_id} with the project ID. */ name?: string; - /** - * Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. - */ - orphanDependents?: boolean; /** * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. */ propagationPolicy?: string; } - export interface Params$Resource$Namespaces$Domainmappings$Get + export interface Params$Resource$Namespaces$Cloudauditlogs$Get extends StandardParameters { /** * Auth client or API Key for the request @@ -2961,11 +3035,11 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the domain mapping being retrieved. If needed, replace {namespace_id} with the project ID. + * The name of the cloudauditlog being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; } - export interface Params$Resource$Namespaces$Domainmappings$List + export interface Params$Resource$Namespaces$Cloudauditlogs$List extends StandardParameters { /** * Auth client or API Key for the request @@ -2993,7 +3067,7 @@ export namespace run_v1alpha1 { */ limit?: number; /** - * The project ID or project number from which the domain mappings should be listed. + * The project ID or project number from which the cloudauditlogs should be listed. */ parent?: string; /** @@ -3005,55 +3079,72 @@ export namespace run_v1alpha1 { */ watch?: boolean; } + export interface Params$Resource$Namespaces$Cloudauditlogs$Replacecloudauditlog + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - export class Resource$Namespaces$Eventtypes { + /** + * The name of the cloudauditlog being retrieved. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CloudAuditLog; + } + + export class Resource$Namespaces$Configurations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * run.namespaces.eventtypes.get - * @desc Rpc to get information about an EventType. - * @alias run.namespaces.eventtypes.get + * run.namespaces.configurations.get + * @desc Rpc to get information about a configuration. + * @alias run.namespaces.configurations.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the trigger being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {string} params.name The name of the configuration being retrieved. If needed, replace {namespace_id} with the project ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get( - params?: Params$Resource$Namespaces$Eventtypes$Get, + params?: Params$Resource$Namespaces$Configurations$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Namespaces$Eventtypes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Configurations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Namespaces$Eventtypes$Get, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Configurations$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Namespaces$Eventtypes$Get - | BodyResponseCallback, + | Params$Resource$Namespaces$Configurations$Get + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Eventtypes$Get; + {}) as Params$Resource$Namespaces$Configurations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Eventtypes$Get; + params = {} as Params$Resource$Namespaces$Configurations$Get; options = {}; } @@ -3067,7 +3158,7 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + '/apis/eventing.knative.dev/v1alpha1/{+name}' + rootUrl + '/apis/serving.knative.dev/v1alpha1/{+name}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, @@ -3079,16 +3170,16 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.namespaces.eventtypes.list - * @desc Rpc to list EventTypes. - * @alias run.namespaces.eventtypes.list + * run.namespaces.configurations.list + * @desc Rpc to list configurations. + * @alias run.namespaces.configurations.list * @memberOf! () * * @param {object} params Parameters for request @@ -3097,7 +3188,7 @@ export namespace run_v1alpha1 { * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the EventTypes should be listed. + * @param {string} params.parent The project ID or project number from which the configurations should be listed. * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3105,37 +3196,39 @@ export namespace run_v1alpha1 { * @return {object} Request object */ list( - params?: Params$Resource$Namespaces$Eventtypes$List, + params?: Params$Resource$Namespaces$Configurations$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Namespaces$Eventtypes$List, + params: Params$Resource$Namespaces$Configurations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Namespaces$Eventtypes$List, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Configurations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Namespaces$Eventtypes$List - | BodyResponseCallback, + | Params$Resource$Namespaces$Configurations$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Eventtypes$List; + {}) as Params$Resource$Namespaces$Configurations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Eventtypes$List; + params = {} as Params$Resource$Namespaces$Configurations$List; options = {}; } @@ -3150,7 +3243,7 @@ export namespace run_v1alpha1 { { url: ( rootUrl + - '/apis/eventing.knative.dev/v1alpha1/{+parent}/eventtypes' + '/apis/serving.knative.dev/v1alpha1/{+parent}/configurations' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, @@ -3162,14 +3255,17 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, + callback + ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Namespaces$Eventtypes$Get + export interface Params$Resource$Namespaces$Configurations$Get extends StandardParameters { /** * Auth client or API Key for the request @@ -3177,11 +3273,11 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the trigger being retrieved. If needed, replace {namespace_id} with the project ID. + * The name of the configuration being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; } - export interface Params$Resource$Namespaces$Eventtypes$List + export interface Params$Resource$Namespaces$Configurations$List extends StandardParameters { /** * Auth client or API Key for the request @@ -3209,7 +3305,7 @@ export namespace run_v1alpha1 { */ limit?: number; /** - * The project ID or project number from which the EventTypes should be listed. + * The project ID or project number from which the configurations should be listed. */ parent?: string; /** @@ -3222,53 +3318,55 @@ export namespace run_v1alpha1 { watch?: boolean; } - export class Resource$Namespaces$Pubsubs { + export class Resource$Namespaces$Domainmappings { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * run.namespaces.pubsubs.create - * @desc Creates a new pubsub. - * @alias run.namespaces.pubsubs.create + * run.namespaces.domainmappings.create + * @desc Creates a new domain mapping. + * @alias run.namespaces.domainmappings.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The project ID or project number in which this pubsub should be created. - * @param {().PubSub} params.requestBody Request body data + * @param {string} params.parent The project ID or project number in which this domain mapping should be created. + * @param {().DomainMapping} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ create( - params?: Params$Resource$Namespaces$Pubsubs$Create, + params?: Params$Resource$Namespaces$Domainmappings$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Namespaces$Pubsubs$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Domainmappings$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Namespaces$Pubsubs$Create, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Domainmappings$Create, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Namespaces$Pubsubs$Create - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Domainmappings$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Pubsubs$Create; + {}) as Params$Resource$Namespaces$Domainmappings$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Pubsubs$Create; + params = {} as Params$Resource$Namespaces$Domainmappings$Create; options = {}; } @@ -3283,7 +3381,7 @@ export namespace run_v1alpha1 { { url: ( rootUrl + - '/apis/events.cloud.google.com/v1alpha1/{+parent}/pubsubs' + '/apis/domains.cloudrun.com/v1alpha1/{+parent}/domainmappings' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, @@ -3295,55 +3393,56 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.namespaces.pubsubs.delete - * @desc Rpc to delete a pubsub. - * @alias run.namespaces.pubsubs.delete + * run.namespaces.domainmappings.delete + * @desc Rpc to delete a domain mapping. + * @alias run.namespaces.domainmappings.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. * @param {string=} params.kind Cloud Run currently ignores this parameter. - * @param {string} params.name The name of the pubsub being deleted. If needed, replace {namespace_id} with the project ID. + * @param {string} params.name The name of the domain mapping being deleted. If needed, replace {namespace_id} with the project ID. + * @param {boolean=} params.orphanDependents Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete( - params?: Params$Resource$Namespaces$Pubsubs$Delete, + params?: Params$Resource$Namespaces$Domainmappings$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Namespaces$Pubsubs$Delete, + params: Params$Resource$Namespaces$Domainmappings$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Namespaces$Pubsubs$Delete, + params: Params$Resource$Namespaces$Domainmappings$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Namespaces$Pubsubs$Delete + | Params$Resource$Namespaces$Domainmappings$Delete | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Pubsubs$Delete; + {}) as Params$Resource$Namespaces$Domainmappings$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Pubsubs$Delete; + params = {} as Params$Resource$Namespaces$Domainmappings$Delete; options = {}; } @@ -3357,7 +3456,7 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + '/apis/events.cloud.google.com/v1alpha1/{+name}' + rootUrl + '/apis/domains.cloudrun.com/v1alpha1/{+name}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE', }, @@ -3376,45 +3475,47 @@ export namespace run_v1alpha1 { } /** - * run.namespaces.pubsubs.get - * @desc Rpc to get information about a pubsub. - * @alias run.namespaces.pubsubs.get + * run.namespaces.domainmappings.get + * @desc Rpc to get information about a domain mapping. + * @alias run.namespaces.domainmappings.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the pubsub being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {string} params.name The name of the domain mapping being retrieved. If needed, replace {namespace_id} with the project ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get( - params?: Params$Resource$Namespaces$Pubsubs$Get, + params?: Params$Resource$Namespaces$Domainmappings$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Namespaces$Pubsubs$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Domainmappings$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Namespaces$Pubsubs$Get, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Domainmappings$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Namespaces$Pubsubs$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Domainmappings$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Pubsubs$Get; + {}) as Params$Resource$Namespaces$Domainmappings$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Pubsubs$Get; + params = {} as Params$Resource$Namespaces$Domainmappings$Get; options = {}; } @@ -3428,7 +3529,7 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + '/apis/events.cloud.google.com/v1alpha1/{+name}' + rootUrl + '/apis/domains.cloudrun.com/v1alpha1/{+name}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, @@ -3440,16 +3541,16 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.namespaces.pubsubs.list - * @desc Rpc to list pubsubs. - * @alias run.namespaces.pubsubs.list + * run.namespaces.domainmappings.list + * @desc Rpc to list domain mappings. + * @alias run.namespaces.domainmappings.list * @memberOf! () * * @param {object} params Parameters for request @@ -3458,7 +3559,7 @@ export namespace run_v1alpha1 { * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the pubsubs should be listed. + * @param {string} params.parent The project ID or project number from which the domain mappings should be listed. * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3466,35 +3567,39 @@ export namespace run_v1alpha1 { * @return {object} Request object */ list( - params?: Params$Resource$Namespaces$Pubsubs$List, + params?: Params$Resource$Namespaces$Domainmappings$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Namespaces$Pubsubs$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Domainmappings$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Namespaces$Pubsubs$List, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Domainmappings$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Namespaces$Pubsubs$List - | BodyResponseCallback, + | Params$Resource$Namespaces$Domainmappings$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Pubsubs$List; + {}) as Params$Resource$Namespaces$Domainmappings$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Pubsubs$List; + params = {} as Params$Resource$Namespaces$Domainmappings$List; options = {}; } @@ -3509,7 +3614,7 @@ export namespace run_v1alpha1 { { url: ( rootUrl + - '/apis/events.cloud.google.com/v1alpha1/{+parent}/pubsubs' + '/apis/domains.cloudrun.com/v1alpha1/{+parent}/domainmappings' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, @@ -3521,86 +3626,17 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * run.namespaces.pubsubs.replacePubSub - * @desc Rpc to replace a pubsub. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. - * @alias run.namespaces.pubsubs.replacePubSub - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the pubsub being retrieved. If needed, replace {namespace_id} with the project ID. - * @param {().PubSub} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - replacePubSub( - params?: Params$Resource$Namespaces$Pubsubs$Replacepubsub, - options?: MethodOptions - ): GaxiosPromise; - replacePubSub( - params: Params$Resource$Namespaces$Pubsubs$Replacepubsub, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - replacePubSub( - params: Params$Resource$Namespaces$Pubsubs$Replacepubsub, - callback: BodyResponseCallback - ): void; - replacePubSub(callback: BodyResponseCallback): void; - replacePubSub( - paramsOrCallback?: - | Params$Resource$Namespaces$Pubsubs$Replacepubsub - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Pubsubs$Replacepubsub; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Pubsubs$Replacepubsub; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/apis/events.cloud.google.com/v1alpha1/{+name}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, + callback + ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Namespaces$Pubsubs$Create + export interface Params$Resource$Namespaces$Domainmappings$Create extends StandardParameters { /** * Auth client or API Key for the request @@ -3608,16 +3644,16 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project ID or project number in which this pubsub should be created. + * The project ID or project number in which this domain mapping should be created. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$PubSub; + requestBody?: Schema$DomainMapping; } - export interface Params$Resource$Namespaces$Pubsubs$Delete + export interface Params$Resource$Namespaces$Domainmappings$Delete extends StandardParameters { /** * Auth client or API Key for the request @@ -3633,15 +3669,19 @@ export namespace run_v1alpha1 { */ kind?: string; /** - * The name of the pubsub being deleted. If needed, replace {namespace_id} with the project ID. + * The name of the domain mapping being deleted. If needed, replace {namespace_id} with the project ID. */ name?: string; + /** + * Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. + */ + orphanDependents?: boolean; /** * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. */ propagationPolicy?: string; } - export interface Params$Resource$Namespaces$Pubsubs$Get + export interface Params$Resource$Namespaces$Domainmappings$Get extends StandardParameters { /** * Auth client or API Key for the request @@ -3649,11 +3689,11 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the pubsub being retrieved. If needed, replace {namespace_id} with the project ID. + * The name of the domain mapping being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; } - export interface Params$Resource$Namespaces$Pubsubs$List + export interface Params$Resource$Namespaces$Domainmappings$List extends StandardParameters { /** * Auth client or API Key for the request @@ -3681,7 +3721,7 @@ export namespace run_v1alpha1 { */ limit?: number; /** - * The project ID or project number from which the pubsubs should be listed. + * The project ID or project number from which the domain mappings should be listed. */ parent?: string; /** @@ -3693,74 +3733,55 @@ export namespace run_v1alpha1 { */ watch?: boolean; } - export interface Params$Resource$Namespaces$Pubsubs$Replacepubsub - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the pubsub being retrieved. If needed, replace {namespace_id} with the project ID. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$PubSub; - } - export class Resource$Namespaces$Revisions { + export class Resource$Namespaces$Eventtypes { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * run.namespaces.revisions.delete - * @desc Rpc to delete a revision. - * @alias run.namespaces.revisions.delete + * run.namespaces.eventtypes.get + * @desc Rpc to get information about an EventType. + * @alias run.namespaces.eventtypes.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. - * @param {string=} params.kind Cloud Run currently ignores this parameter. - * @param {string} params.name The name of the revision being deleted. If needed, replace {namespace_id} with the project ID. - * @param {boolean=} params.orphanDependents Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. - * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. + * @param {string} params.name The name of the trigger being retrieved. If needed, replace {namespace_id} with the project ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - delete( - params?: Params$Resource$Namespaces$Revisions$Delete, + get( + params?: Params$Resource$Namespaces$Eventtypes$Get, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Namespaces$Revisions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + get( + params: Params$Resource$Namespaces$Eventtypes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Namespaces$Revisions$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Namespaces$Eventtypes$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Namespaces$Revisions$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Eventtypes$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Revisions$Delete; + {}) as Params$Resource$Namespaces$Eventtypes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Revisions$Delete; + params = {} as Params$Resource$Namespaces$Eventtypes$Get; options = {}; } @@ -3774,9 +3795,9 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + '/apis/serving.knative.dev/v1alpha1/{+name}' + rootUrl + '/apis/eventing.knative.dev/v1alpha1/{+name}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', }, options ), @@ -3786,87 +3807,16 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); - } - } - - /** - * run.namespaces.revisions.get - * @desc Rpc to get information about a revision. - * @alias run.namespaces.revisions.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the revision being retrieved. If needed, replace {namespace_id} with the project ID. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Namespaces$Revisions$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Namespaces$Revisions$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Namespaces$Revisions$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Namespaces$Revisions$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Revisions$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Revisions$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/apis/serving.knative.dev/v1alpha1/{+name}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.namespaces.revisions.list - * @desc Rpc to list revisions. - * @alias run.namespaces.revisions.list + * run.namespaces.eventtypes.list + * @desc Rpc to list EventTypes. + * @alias run.namespaces.eventtypes.list * @memberOf! () * * @param {object} params Parameters for request @@ -3875,7 +3825,7 @@ export namespace run_v1alpha1 { * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the revisions should be listed. + * @param {string} params.parent The project ID or project number from which the EventTypes should be listed. * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3883,37 +3833,37 @@ export namespace run_v1alpha1 { * @return {object} Request object */ list( - params?: Params$Resource$Namespaces$Revisions$List, + params?: Params$Resource$Namespaces$Eventtypes$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Namespaces$Revisions$List, + params: Params$Resource$Namespaces$Eventtypes$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Namespaces$Revisions$List, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Eventtypes$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Namespaces$Revisions$List - | BodyResponseCallback, + | Params$Resource$Namespaces$Eventtypes$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Revisions$List; + {}) as Params$Resource$Namespaces$Eventtypes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Revisions$List; + params = {} as Params$Resource$Namespaces$Eventtypes$List; options = {}; } @@ -3927,7 +3877,8 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + '/apis/serving.knative.dev/v1alpha1/{+parent}/revisions' + rootUrl + + '/apis/eventing.knative.dev/v1alpha1/{+parent}/eventtypes' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, @@ -3939,42 +3890,14 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Namespaces$Revisions$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Cloud Run currently ignores this parameter. - */ - apiVersion?: string; - /** - * Cloud Run currently ignores this parameter. - */ - kind?: string; - /** - * The name of the revision being deleted. If needed, replace {namespace_id} with the project ID. - */ - name?: string; - /** - * Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. - */ - orphanDependents?: boolean; - /** - * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. - */ - propagationPolicy?: string; - } - export interface Params$Resource$Namespaces$Revisions$Get + export interface Params$Resource$Namespaces$Eventtypes$Get extends StandardParameters { /** * Auth client or API Key for the request @@ -3982,11 +3905,11 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the revision being retrieved. If needed, replace {namespace_id} with the project ID. + * The name of the trigger being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; } - export interface Params$Resource$Namespaces$Revisions$List + export interface Params$Resource$Namespaces$Eventtypes$List extends StandardParameters { /** * Auth client or API Key for the request @@ -4014,7 +3937,7 @@ export namespace run_v1alpha1 { */ limit?: number; /** - * The project ID or project number from which the revisions should be listed. + * The project ID or project number from which the EventTypes should be listed. */ parent?: string; /** @@ -4027,52 +3950,53 @@ export namespace run_v1alpha1 { watch?: boolean; } - export class Resource$Namespaces$Routes { + export class Resource$Namespaces$Pubsubs { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * run.namespaces.routes.get - * @desc Rpc to get information about a route. - * @alias run.namespaces.routes.get + * run.namespaces.pubsubs.create + * @desc Creates a new pubsub. + * @alias run.namespaces.pubsubs.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the route being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {string} params.parent The project ID or project number in which this pubsub should be created. + * @param {().PubSub} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - get( - params?: Params$Resource$Namespaces$Routes$Get, + create( + params?: Params$Resource$Namespaces$Pubsubs$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Namespaces$Routes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + create( + params: Params$Resource$Namespaces$Pubsubs$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Namespaces$Routes$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Namespaces$Pubsubs$Create, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Namespaces$Routes$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Pubsubs$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Routes$Get; + {}) as Params$Resource$Namespaces$Pubsubs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Routes$Get; + params = {} as Params$Resource$Namespaces$Pubsubs$Create; options = {}; } @@ -4086,73 +4010,68 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + '/apis/serving.knative.dev/v1alpha1/{+name}' + rootUrl + + '/apis/events.cloud.google.com/v1alpha1/{+parent}/pubsubs' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.namespaces.routes.list - * @desc Rpc to list routes. - * @alias run.namespaces.routes.list + * run.namespaces.pubsubs.delete + * @desc Rpc to delete a pubsub. + * @alias run.namespaces.pubsubs.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.continue Optional encoded string to continue paging. - * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. - * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. - * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. - * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the routes should be listed. - * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. - * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. + * @param {string=} params.kind Cloud Run currently ignores this parameter. + * @param {string} params.name The name of the pubsub being deleted. If needed, replace {namespace_id} with the project ID. + * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - list( - params?: Params$Resource$Namespaces$Routes$List, + delete( + params?: Params$Resource$Namespaces$Pubsubs$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Namespaces$Routes$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + delete( + params: Params$Resource$Namespaces$Pubsubs$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Namespaces$Routes$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Namespaces$Pubsubs$Delete, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Namespaces$Routes$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Pubsubs$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Routes$List; + {}) as Params$Resource$Namespaces$Pubsubs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Routes$List; + params = {} as Params$Resource$Namespaces$Pubsubs$Delete; options = {}; } @@ -4166,125 +4085,64 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + '/apis/serving.knative.dev/v1alpha1/{+parent}/routes' + rootUrl + '/apis/events.cloud.google.com/v1alpha1/{+name}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Namespaces$Routes$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the route being retrieved. If needed, replace {namespace_id} with the project ID. - */ - name?: string; - } - export interface Params$Resource$Namespaces$Routes$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Optional encoded string to continue paging. - */ - continue?: string; - /** - * Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. - */ - fieldSelector?: string; - /** - * Not currently used by Cloud Run. - */ - includeUninitialized?: boolean; - /** - * Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. - */ - labelSelector?: string; - /** - * The maximum number of records that should be returned. - */ - limit?: number; - /** - * The project ID or project number from which the routes should be listed. - */ - parent?: string; - /** - * The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. - */ - resourceVersion?: string; - /** - * Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. - */ - watch?: boolean; - } - - export class Resource$Namespaces$Services { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * run.namespaces.services.create - * @desc Rpc to create a service. - * @alias run.namespaces.services.create + * run.namespaces.pubsubs.get + * @desc Rpc to get information about a pubsub. + * @alias run.namespaces.pubsubs.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The project ID or project number in which this service should be created. - * @param {().Service} params.requestBody Request body data + * @param {string} params.name The name of the pubsub being retrieved. If needed, replace {namespace_id} with the project ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - create( - params?: Params$Resource$Namespaces$Services$Create, + get( + params?: Params$Resource$Namespaces$Pubsubs$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Namespaces$Services$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + get( + params: Params$Resource$Namespaces$Pubsubs$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Namespaces$Services$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Namespaces$Pubsubs$Get, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Namespaces$Services$Create - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Pubsubs$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Services$Create; + {}) as Params$Resource$Namespaces$Pubsubs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Services$Create; + params = {} as Params$Resource$Namespaces$Pubsubs$Get; options = {}; } @@ -4298,68 +4156,73 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + '/apis/serving.knative.dev/v1alpha1/{+parent}/services' + rootUrl + '/apis/events.cloud.google.com/v1alpha1/{+name}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.namespaces.services.delete - * @desc Rpc to delete a service. This will cause the Service to stop serving traffic and will delete the child entities like Routes, Configurations and Revisions. - * @alias run.namespaces.services.delete + * run.namespaces.pubsubs.list + * @desc Rpc to list pubsubs. + * @alias run.namespaces.pubsubs.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. - * @param {string=} params.kind Cloud Run currently ignores this parameter. - * @param {string} params.name The name of the service being deleted. If needed, replace {namespace_id} with the project ID. - * @param {boolean=} params.orphanDependents Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. - * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. + * @param {string=} params.continue Optional encoded string to continue paging. + * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. + * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + * @param {integer=} params.limit The maximum number of records that should be returned. + * @param {string} params.parent The project ID or project number from which the pubsubs should be listed. + * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - delete( - params?: Params$Resource$Namespaces$Services$Delete, + list( + params?: Params$Resource$Namespaces$Pubsubs$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Namespaces$Services$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + list( + params: Params$Resource$Namespaces$Pubsubs$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Namespaces$Services$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Namespaces$Pubsubs$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Namespaces$Services$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Pubsubs$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Services$Delete; + {}) as Params$Resource$Namespaces$Pubsubs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Services$Delete; + params = {} as Params$Resource$Namespaces$Pubsubs$List; options = {}; } @@ -4373,218 +4236,66 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + '/apis/serving.knative.dev/v1alpha1/{+name}' + rootUrl + + '/apis/events.cloud.google.com/v1alpha1/{+parent}/pubsubs' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.namespaces.services.get - * @desc Rpc to get information about a service. - * @alias run.namespaces.services.get + * run.namespaces.pubsubs.replacePubSub + * @desc Rpc to replace a pubsub. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. + * @alias run.namespaces.pubsubs.replacePubSub * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the service being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {string} params.name The name of the pubsub being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {().PubSub} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - get( - params?: Params$Resource$Namespaces$Services$Get, + replacePubSub( + params?: Params$Resource$Namespaces$Pubsubs$Replacepubsub, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Namespaces$Services$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + replacePubSub( + params: Params$Resource$Namespaces$Pubsubs$Replacepubsub, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Namespaces$Services$Get, - callback: BodyResponseCallback + replacePubSub( + params: Params$Resource$Namespaces$Pubsubs$Replacepubsub, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + replacePubSub(callback: BodyResponseCallback): void; + replacePubSub( paramsOrCallback?: - | Params$Resource$Namespaces$Services$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Services$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Services$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/apis/serving.knative.dev/v1alpha1/{+name}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * run.namespaces.services.list - * @desc Rpc to list services. - * @alias run.namespaces.services.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.continue Optional encoded string to continue paging. - * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. - * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. - * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. - * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the services should be listed. - * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. - * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Namespaces$Services$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Namespaces$Services$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Namespaces$Services$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Namespaces$Services$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Services$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Services$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/apis/serving.knative.dev/v1alpha1/{+parent}/services' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * run.namespaces.services.replaceService - * @desc Rpc to replace a service. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. - * @alias run.namespaces.services.replaceService - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the service being replaced. If needed, replace {namespace_id} with the project ID. - * @param {().Service} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - replaceService( - params?: Params$Resource$Namespaces$Services$Replaceservice, - options?: MethodOptions - ): GaxiosPromise; - replaceService( - params: Params$Resource$Namespaces$Services$Replaceservice, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - replaceService( - params: Params$Resource$Namespaces$Services$Replaceservice, - callback: BodyResponseCallback - ): void; - replaceService(callback: BodyResponseCallback): void; - replaceService( - paramsOrCallback?: - | Params$Resource$Namespaces$Services$Replaceservice - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Pubsubs$Replacepubsub + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Services$Replaceservice; + {}) as Params$Resource$Namespaces$Pubsubs$Replacepubsub; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Services$Replaceservice; + params = {} as Params$Resource$Namespaces$Pubsubs$Replacepubsub; options = {}; } @@ -4598,7 +4309,7 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + '/apis/serving.knative.dev/v1alpha1/{+name}' + rootUrl + '/apis/events.cloud.google.com/v1alpha1/{+name}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'PUT', }, @@ -4610,14 +4321,14 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Namespaces$Services$Create + export interface Params$Resource$Namespaces$Pubsubs$Create extends StandardParameters { /** * Auth client or API Key for the request @@ -4625,16 +4336,16 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project ID or project number in which this service should be created. + * The project ID or project number in which this pubsub should be created. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$Service; + requestBody?: Schema$PubSub; } - export interface Params$Resource$Namespaces$Services$Delete + export interface Params$Resource$Namespaces$Pubsubs$Delete extends StandardParameters { /** * Auth client or API Key for the request @@ -4650,19 +4361,15 @@ export namespace run_v1alpha1 { */ kind?: string; /** - * The name of the service being deleted. If needed, replace {namespace_id} with the project ID. + * The name of the pubsub being deleted. If needed, replace {namespace_id} with the project ID. */ name?: string; - /** - * Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. - */ - orphanDependents?: boolean; /** * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. */ propagationPolicy?: string; } - export interface Params$Resource$Namespaces$Services$Get + export interface Params$Resource$Namespaces$Pubsubs$Get extends StandardParameters { /** * Auth client or API Key for the request @@ -4670,11 +4377,11 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the service being retrieved. If needed, replace {namespace_id} with the project ID. + * The name of the pubsub being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; } - export interface Params$Resource$Namespaces$Services$List + export interface Params$Resource$Namespaces$Pubsubs$List extends StandardParameters { /** * Auth client or API Key for the request @@ -4702,7 +4409,7 @@ export namespace run_v1alpha1 { */ limit?: number; /** - * The project ID or project number from which the services should be listed. + * The project ID or project number from which the pubsubs should be listed. */ parent?: string; /** @@ -4714,7 +4421,7 @@ export namespace run_v1alpha1 { */ watch?: boolean; } - export interface Params$Resource$Namespaces$Services$Replaceservice + export interface Params$Resource$Namespaces$Pubsubs$Replacepubsub extends StandardParameters { /** * Auth client or API Key for the request @@ -4722,63 +4429,66 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the service being replaced. If needed, replace {namespace_id} with the project ID. + * The name of the pubsub being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; /** * Request body metadata */ - requestBody?: Schema$Service; + requestBody?: Schema$PubSub; } - export class Resource$Namespaces$Triggers { + export class Resource$Namespaces$Revisions { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * run.namespaces.triggers.create - * @desc Creates a new trigger. - * @alias run.namespaces.triggers.create + * run.namespaces.revisions.delete + * @desc Rpc to delete a revision. + * @alias run.namespaces.revisions.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The project ID or project number in which this trigger should be created. - * @param {().Trigger} params.requestBody Request body data + * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. + * @param {string=} params.kind Cloud Run currently ignores this parameter. + * @param {string} params.name The name of the revision being deleted. If needed, replace {namespace_id} with the project ID. + * @param {boolean=} params.orphanDependents Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. + * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - create( - params?: Params$Resource$Namespaces$Triggers$Create, + delete( + params?: Params$Resource$Namespaces$Revisions$Delete, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Namespaces$Triggers$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + delete( + params: Params$Resource$Namespaces$Revisions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Namespaces$Triggers$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Namespaces$Revisions$Delete, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Namespaces$Triggers$Create - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Revisions$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Triggers$Create; + {}) as Params$Resource$Namespaces$Revisions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Triggers$Create; + params = {} as Params$Resource$Namespaces$Revisions$Delete; options = {}; } @@ -4792,81 +4502,7 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + '/apis/eventing.knative.dev/v1alpha1/{+parent}/triggers' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * run.namespaces.triggers.delete - * @desc Rpc to delete a trigger. - * @alias run.namespaces.triggers.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. - * @param {string=} params.kind Cloud Run currently ignores this parameter. - * @param {string} params.name The name of the trigger being deleted. If needed, replace {namespace_id} with the project ID. - * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Namespaces$Triggers$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Namespaces$Triggers$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Namespaces$Triggers$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Namespaces$Triggers$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Triggers$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Triggers$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/apis/eventing.knative.dev/v1alpha1/{+name}' + rootUrl + '/apis/serving.knative.dev/v1alpha1/{+name}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE', }, @@ -4885,45 +4521,45 @@ export namespace run_v1alpha1 { } /** - * run.namespaces.triggers.get - * @desc Rpc to get information about a trigger. - * @alias run.namespaces.triggers.get + * run.namespaces.revisions.get + * @desc Rpc to get information about a revision. + * @alias run.namespaces.revisions.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the trigger being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {string} params.name The name of the revision being retrieved. If needed, replace {namespace_id} with the project ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get( - params?: Params$Resource$Namespaces$Triggers$Get, + params?: Params$Resource$Namespaces$Revisions$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Namespaces$Triggers$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Revisions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Namespaces$Triggers$Get, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Revisions$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Namespaces$Triggers$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Revisions$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Triggers$Get; + {}) as Params$Resource$Namespaces$Revisions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Triggers$Get; + params = {} as Params$Resource$Namespaces$Revisions$Get; options = {}; } @@ -4937,7 +4573,7 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + '/apis/eventing.knative.dev/v1alpha1/{+name}' + rootUrl + '/apis/serving.knative.dev/v1alpha1/{+name}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, @@ -4949,16 +4585,16 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.namespaces.triggers.list - * @desc Rpc to list triggers. - * @alias run.namespaces.triggers.list + * run.namespaces.revisions.list + * @desc Rpc to list revisions. + * @alias run.namespaces.revisions.list * @memberOf! () * * @param {object} params Parameters for request @@ -4967,7 +4603,7 @@ export namespace run_v1alpha1 { * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the triggers should be listed. + * @param {string} params.parent The project ID or project number from which the revisions should be listed. * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4975,37 +4611,37 @@ export namespace run_v1alpha1 { * @return {object} Request object */ list( - params?: Params$Resource$Namespaces$Triggers$List, + params?: Params$Resource$Namespaces$Revisions$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Namespaces$Triggers$List, + params: Params$Resource$Namespaces$Revisions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Namespaces$Triggers$List, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Revisions$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Namespaces$Triggers$List - | BodyResponseCallback, + | Params$Resource$Namespaces$Revisions$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Triggers$List; + {}) as Params$Resource$Namespaces$Revisions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Triggers$List; + params = {} as Params$Resource$Namespaces$Revisions$List; options = {}; } @@ -5019,7 +4655,7 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + '/apis/eventing.knative.dev/v1alpha1/{+parent}/triggers' + rootUrl + '/apis/serving.knative.dev/v1alpha1/{+parent}/revisions' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, @@ -5031,103 +4667,14 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * run.namespaces.triggers.replaceTrigger - * @desc Rpc to replace a trigger. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. - * @alias run.namespaces.triggers.replaceTrigger - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the trigger being retrieved. If needed, replace {namespace_id} with the project ID. - * @param {().Trigger} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - replaceTrigger( - params?: Params$Resource$Namespaces$Triggers$Replacetrigger, - options?: MethodOptions - ): GaxiosPromise; - replaceTrigger( - params: Params$Resource$Namespaces$Triggers$Replacetrigger, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - replaceTrigger( - params: Params$Resource$Namespaces$Triggers$Replacetrigger, - callback: BodyResponseCallback - ): void; - replaceTrigger(callback: BodyResponseCallback): void; - replaceTrigger( - paramsOrCallback?: - | Params$Resource$Namespaces$Triggers$Replacetrigger - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Triggers$Replacetrigger; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Triggers$Replacetrigger; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/apis/eventing.knative.dev/v1alpha1/{+name}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Namespaces$Triggers$Create - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The project ID or project number in which this trigger should be created. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Trigger; - } - export interface Params$Resource$Namespaces$Triggers$Delete + export interface Params$Resource$Namespaces$Revisions$Delete extends StandardParameters { /** * Auth client or API Key for the request @@ -5143,15 +4690,19 @@ export namespace run_v1alpha1 { */ kind?: string; /** - * The name of the trigger being deleted. If needed, replace {namespace_id} with the project ID. + * The name of the revision being deleted. If needed, replace {namespace_id} with the project ID. */ name?: string; /** - * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. + * Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. + */ + orphanDependents?: boolean; + /** + * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. */ propagationPolicy?: string; } - export interface Params$Resource$Namespaces$Triggers$Get + export interface Params$Resource$Namespaces$Revisions$Get extends StandardParameters { /** * Auth client or API Key for the request @@ -5159,11 +4710,11 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the trigger being retrieved. If needed, replace {namespace_id} with the project ID. + * The name of the revision being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; } - export interface Params$Resource$Namespaces$Triggers$List + export interface Params$Resource$Namespaces$Revisions$List extends StandardParameters { /** * Auth client or API Key for the request @@ -5191,7 +4742,7 @@ export namespace run_v1alpha1 { */ limit?: number; /** - * The project ID or project number from which the triggers should be listed. + * The project ID or project number from which the revisions should be listed. */ parent?: string; /** @@ -5203,112 +4754,53 @@ export namespace run_v1alpha1 { */ watch?: boolean; } - export interface Params$Resource$Namespaces$Triggers$Replacetrigger - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the trigger being retrieved. If needed, replace {namespace_id} with the project ID. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Trigger; - } - - export class Resource$Projects { - context: APIRequestContext; - locations: Resource$Projects$Locations; - constructor(context: APIRequestContext) { - this.context = context; - this.locations = new Resource$Projects$Locations(this.context); - } - } - export class Resource$Projects$Locations { + export class Resource$Namespaces$Routes { context: APIRequestContext; - authorizeddomains: Resource$Projects$Locations$Authorizeddomains; - configurations: Resource$Projects$Locations$Configurations; - domainmappings: Resource$Projects$Locations$Domainmappings; - eventtypes: Resource$Projects$Locations$Eventtypes; - pubsubs: Resource$Projects$Locations$Pubsubs; - revisions: Resource$Projects$Locations$Revisions; - routes: Resource$Projects$Locations$Routes; - services: Resource$Projects$Locations$Services; - triggers: Resource$Projects$Locations$Triggers; constructor(context: APIRequestContext) { this.context = context; - this.authorizeddomains = new Resource$Projects$Locations$Authorizeddomains( - this.context - ); - this.configurations = new Resource$Projects$Locations$Configurations( - this.context - ); - this.domainmappings = new Resource$Projects$Locations$Domainmappings( - this.context - ); - this.eventtypes = new Resource$Projects$Locations$Eventtypes( - this.context - ); - this.pubsubs = new Resource$Projects$Locations$Pubsubs(this.context); - this.revisions = new Resource$Projects$Locations$Revisions(this.context); - this.routes = new Resource$Projects$Locations$Routes(this.context); - this.services = new Resource$Projects$Locations$Services(this.context); - this.triggers = new Resource$Projects$Locations$Triggers(this.context); } /** - * run.projects.locations.list - * @desc Lists information about the supported locations for this service. - * @alias run.projects.locations.list + * run.namespaces.routes.get + * @desc Rpc to get information about a route. + * @alias run.namespaces.routes.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter The standard list filter. - * @param {string} params.name The resource that owns the locations collection, if applicable. - * @param {integer=} params.pageSize The standard list page size. - * @param {string=} params.pageToken The standard list page token. + * @param {string} params.name The name of the route being retrieved. If needed, replace {namespace_id} with the project ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - list( - params?: Params$Resource$Projects$Locations$List, + get( + params?: Params$Resource$Namespaces$Routes$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + get( + params: Params$Resource$Namespaces$Routes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Namespaces$Routes$Get, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Routes$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$List; + {}) as Params$Resource$Namespaces$Routes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$List; + params = {} as Params$Resource$Namespaces$Routes$Get; options = {}; } @@ -5321,10 +4813,9 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+name}/locations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/apis/serving.knative.dev/v1alpha1/{+name}' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options @@ -5335,92 +4826,61 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The standard list filter. - */ - filter?: string; - /** - * The resource that owns the locations collection, if applicable. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Authorizeddomains { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * run.projects.locations.authorizeddomains.list - * @desc RPC to list authorized domains. - * @alias run.projects.locations.authorizeddomains.list + * run.namespaces.routes.list + * @desc Rpc to list routes. + * @alias run.namespaces.routes.list * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.pageSize Maximum results to return per page. - * @param {string=} params.pageToken Continuation token for fetching the next page of results. - * @param {string} params.parent Name of the parent Application resource. Example: `apps/myapp`. + * @param {string=} params.continue Optional encoded string to continue paging. + * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. + * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + * @param {integer=} params.limit The maximum number of records that should be returned. + * @param {string} params.parent The project ID or project number from which the routes should be listed. + * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list( - params?: Params$Resource$Projects$Locations$Authorizeddomains$List, + params?: Params$Resource$Namespaces$Routes$List, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Authorizeddomains$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Authorizeddomains$List, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Routes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Routes$List, + callback: BodyResponseCallback ): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizeddomains$List - | BodyResponseCallback, + | Params$Resource$Namespaces$Routes$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizeddomains$List; + {}) as Params$Resource$Namespaces$Routes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Authorizeddomains$List; + params = {} as Params$Resource$Namespaces$Routes$List; options = {}; } @@ -5433,10 +4893,9 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+parent}/authorizeddomains').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/apis/serving.knative.dev/v1alpha1/{+parent}/routes' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options @@ -5447,19 +4906,14 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback - ); + createAPIRequest(parameters, callback); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Authorizeddomains$List + export interface Params$Resource$Namespaces$Routes$Get extends StandardParameters { /** * Auth client or API Key for the request @@ -5467,208 +4921,21 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Maximum results to return per page. + * The name of the route being retrieved. If needed, replace {namespace_id} with the project ID. */ - pageSize?: number; + name?: string; + } + export interface Params$Resource$Namespaces$Routes$List + extends StandardParameters { /** - * Continuation token for fetching the next page of results. + * Auth client or API Key for the request */ - pageToken?: string; + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** - * Name of the parent Application resource. Example: `apps/myapp`. + * Optional encoded string to continue paging. */ - parent?: string; - } - - export class Resource$Projects$Locations$Configurations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * run.projects.locations.configurations.get - * @desc Rpc to get information about a configuration. - * @alias run.projects.locations.configurations.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the configuration being retrieved. If needed, replace {namespace_id} with the project ID. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Projects$Locations$Configurations$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Configurations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Configurations$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Configurations$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Configurations$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Configurations$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * run.projects.locations.configurations.list - * @desc Rpc to list configurations. - * @alias run.projects.locations.configurations.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.continue Optional encoded string to continue paging. - * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. - * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. - * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. - * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the configurations should be listed. - * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. - * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Projects$Locations$Configurations$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Configurations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Configurations$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Configurations$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Configurations$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Configurations$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha1/{+parent}/configurations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Configurations$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the configuration being retrieved. If needed, replace {namespace_id} with the project ID. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Configurations$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Optional encoded string to continue paging. - */ - continue?: string; + continue?: string; /** * Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. */ @@ -5686,7 +4953,7 @@ export namespace run_v1alpha1 { */ limit?: number; /** - * The project ID or project number from which the configurations should be listed. + * The project ID or project number from which the routes should be listed. */ parent?: string; /** @@ -5699,55 +4966,53 @@ export namespace run_v1alpha1 { watch?: boolean; } - export class Resource$Projects$Locations$Domainmappings { + export class Resource$Namespaces$Services { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * run.projects.locations.domainmappings.create - * @desc Creates a new domain mapping. - * @alias run.projects.locations.domainmappings.create + * run.namespaces.services.create + * @desc Rpc to create a service. + * @alias run.namespaces.services.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The project ID or project number in which this domain mapping should be created. - * @param {().DomainMapping} params.requestBody Request body data + * @param {string} params.parent The project ID or project number in which this service should be created. + * @param {().Service} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ create( - params?: Params$Resource$Projects$Locations$Domainmappings$Create, + params?: Params$Resource$Namespaces$Services$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Domainmappings$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Services$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Domainmappings$Create, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Services$Create, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Domainmappings$Create - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Services$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Domainmappings$Create; + {}) as Params$Resource$Namespaces$Services$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Domainmappings$Create; + params = {} as Params$Resource$Namespaces$Services$Create; options = {}; } @@ -5760,10 +5025,9 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+parent}/domainmappings').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/apis/serving.knative.dev/v1alpha1/{+parent}/services' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, options @@ -5774,22 +5038,22 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.projects.locations.domainmappings.delete - * @desc Rpc to delete a domain mapping. - * @alias run.projects.locations.domainmappings.delete + * run.namespaces.services.delete + * @desc Rpc to delete a service. This will cause the Service to stop serving traffic and will delete the child entities like Routes, Configurations and Revisions. + * @alias run.namespaces.services.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. * @param {string=} params.kind Cloud Run currently ignores this parameter. - * @param {string} params.name The name of the domain mapping being deleted. If needed, replace {namespace_id} with the project ID. + * @param {string} params.name The name of the service being deleted. If needed, replace {namespace_id} with the project ID. * @param {boolean=} params.orphanDependents Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5797,33 +5061,33 @@ export namespace run_v1alpha1 { * @return {object} Request object */ delete( - params?: Params$Resource$Projects$Locations$Domainmappings$Delete, + params?: Params$Resource$Namespaces$Services$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Domainmappings$Delete, + params: Params$Resource$Namespaces$Services$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Domainmappings$Delete, + params: Params$Resource$Namespaces$Services$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Domainmappings$Delete + | Params$Resource$Namespaces$Services$Delete | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Domainmappings$Delete; + {}) as Params$Resource$Namespaces$Services$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Domainmappings$Delete; + params = {} as Params$Resource$Namespaces$Services$Delete; options = {}; } @@ -5836,7 +5100,9 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: ( + rootUrl + '/apis/serving.knative.dev/v1alpha1/{+name}' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE', }, options @@ -5854,47 +5120,45 @@ export namespace run_v1alpha1 { } /** - * run.projects.locations.domainmappings.get - * @desc Rpc to get information about a domain mapping. - * @alias run.projects.locations.domainmappings.get + * run.namespaces.services.get + * @desc Rpc to get information about a service. + * @alias run.namespaces.services.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the domain mapping being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {string} params.name The name of the service being retrieved. If needed, replace {namespace_id} with the project ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get( - params?: Params$Resource$Projects$Locations$Domainmappings$Get, + params?: Params$Resource$Namespaces$Services$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Domainmappings$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Services$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Domainmappings$Get, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Services$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Domainmappings$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Services$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Domainmappings$Get; + {}) as Params$Resource$Namespaces$Services$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Domainmappings$Get; + params = {} as Params$Resource$Namespaces$Services$Get; options = {}; } @@ -5907,7 +5171,9 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: ( + rootUrl + '/apis/serving.knative.dev/v1alpha1/{+name}' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options @@ -5918,16 +5184,16 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.projects.locations.domainmappings.list - * @desc Rpc to list domain mappings. - * @alias run.projects.locations.domainmappings.list + * run.namespaces.services.list + * @desc Rpc to list services. + * @alias run.namespaces.services.list * @memberOf! () * * @param {object} params Parameters for request @@ -5936,7 +5202,7 @@ export namespace run_v1alpha1 { * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the domain mappings should be listed. + * @param {string} params.parent The project ID or project number from which the services should be listed. * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5944,39 +5210,37 @@ export namespace run_v1alpha1 { * @return {object} Request object */ list( - params?: Params$Resource$Projects$Locations$Domainmappings$List, + params?: Params$Resource$Namespaces$Services$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Domainmappings$List, + params: Params$Resource$Namespaces$Services$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Domainmappings$List, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Services$List, + callback: BodyResponseCallback ): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Domainmappings$List - | BodyResponseCallback, + | Params$Resource$Namespaces$Services$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Domainmappings$List; + {}) as Params$Resource$Namespaces$Services$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Domainmappings$List; + params = {} as Params$Resource$Namespaces$Services$List; options = {}; } @@ -5989,10 +5253,9 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+parent}/domainmappings').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/apis/serving.knative.dev/v1alpha1/{+parent}/services' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options @@ -6003,17 +5266,86 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback - ); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); + } + } + + /** + * run.namespaces.services.replaceService + * @desc Rpc to replace a service. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. + * @alias run.namespaces.services.replaceService + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the service being replaced. If needed, replace {namespace_id} with the project ID. + * @param {().Service} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + replaceService( + params?: Params$Resource$Namespaces$Services$Replaceservice, + options?: MethodOptions + ): GaxiosPromise; + replaceService( + params: Params$Resource$Namespaces$Services$Replaceservice, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replaceService( + params: Params$Resource$Namespaces$Services$Replaceservice, + callback: BodyResponseCallback + ): void; + replaceService(callback: BodyResponseCallback): void; + replaceService( + paramsOrCallback?: + | Params$Resource$Namespaces$Services$Replaceservice + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Services$Replaceservice; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$Services$Replaceservice; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/apis/serving.knative.dev/v1alpha1/{+name}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Domainmappings$Create + export interface Params$Resource$Namespaces$Services$Create extends StandardParameters { /** * Auth client or API Key for the request @@ -6021,16 +5353,16 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project ID or project number in which this domain mapping should be created. + * The project ID or project number in which this service should be created. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$DomainMapping; + requestBody?: Schema$Service; } - export interface Params$Resource$Projects$Locations$Domainmappings$Delete + export interface Params$Resource$Namespaces$Services$Delete extends StandardParameters { /** * Auth client or API Key for the request @@ -6046,7 +5378,7 @@ export namespace run_v1alpha1 { */ kind?: string; /** - * The name of the domain mapping being deleted. If needed, replace {namespace_id} with the project ID. + * The name of the service being deleted. If needed, replace {namespace_id} with the project ID. */ name?: string; /** @@ -6058,7 +5390,7 @@ export namespace run_v1alpha1 { */ propagationPolicy?: string; } - export interface Params$Resource$Projects$Locations$Domainmappings$Get + export interface Params$Resource$Namespaces$Services$Get extends StandardParameters { /** * Auth client or API Key for the request @@ -6066,11 +5398,11 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the domain mapping being retrieved. If needed, replace {namespace_id} with the project ID. + * The name of the service being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; } - export interface Params$Resource$Projects$Locations$Domainmappings$List + export interface Params$Resource$Namespaces$Services$List extends StandardParameters { /** * Auth client or API Key for the request @@ -6098,7 +5430,7 @@ export namespace run_v1alpha1 { */ limit?: number; /** - * The project ID or project number from which the domain mappings should be listed. + * The project ID or project number from which the services should be listed. */ parent?: string; /** @@ -6110,55 +5442,71 @@ export namespace run_v1alpha1 { */ watch?: boolean; } + export interface Params$Resource$Namespaces$Services$Replaceservice + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - export class Resource$Projects$Locations$Eventtypes { + /** + * The name of the service being replaced. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Service; + } + + export class Resource$Namespaces$Storages { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * run.projects.locations.eventtypes.get - * @desc Rpc to get information about an EventType. - * @alias run.projects.locations.eventtypes.get + * run.namespaces.storages.create + * @desc Creates a new storage. + * @alias run.namespaces.storages.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the trigger being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {string} params.parent The project ID or project number in which this storage should be created. + * @param {().Storage} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - get( - params?: Params$Resource$Projects$Locations$Eventtypes$Get, + create( + params?: Params$Resource$Namespaces$Storages$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Eventtypes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + create( + params: Params$Resource$Namespaces$Storages$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Eventtypes$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Namespaces$Storages$Create, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Eventtypes$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Storages$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Eventtypes$Get; + {}) as Params$Resource$Namespaces$Storages$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Eventtypes$Get; + params = {} as Params$Resource$Namespaces$Storages$Create; options = {}; } @@ -6171,74 +5519,69 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: ( + rootUrl + + '/apis/events.cloud.google.com/v1alpha1/{+parent}/storages' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.projects.locations.eventtypes.list - * @desc Rpc to list EventTypes. - * @alias run.projects.locations.eventtypes.list + * run.namespaces.storages.delete + * @desc Rpc to delete a storage. + * @alias run.namespaces.storages.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.continue Optional encoded string to continue paging. - * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. - * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. - * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. - * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the EventTypes should be listed. - * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. - * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. + * @param {string=} params.kind Cloud Run currently ignores this parameter. + * @param {string} params.name The name of the storage being deleted. If needed, replace {namespace_id} with the project ID. + * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - list( - params?: Params$Resource$Projects$Locations$Eventtypes$List, + delete( + params?: Params$Resource$Namespaces$Storages$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Eventtypes$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + delete( + params: Params$Resource$Namespaces$Storages$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Eventtypes$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Namespaces$Storages$Delete, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Eventtypes$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Storages$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Eventtypes$List; + {}) as Params$Resource$Namespaces$Storages$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Eventtypes$List; + params = {} as Params$Resource$Namespaces$Storages$Delete; options = {}; } @@ -6251,127 +5594,65 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+parent}/eventtypes').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: ( + rootUrl + '/apis/events.cloud.google.com/v1alpha1/{+name}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Eventtypes$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the trigger being retrieved. If needed, replace {namespace_id} with the project ID. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Eventtypes$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Optional encoded string to continue paging. - */ - continue?: string; - /** - * Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. - */ - fieldSelector?: string; - /** - * Not currently used by Cloud Run. - */ - includeUninitialized?: boolean; - /** - * Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. - */ - labelSelector?: string; - /** - * The maximum number of records that should be returned. - */ - limit?: number; - /** - * The project ID or project number from which the EventTypes should be listed. - */ - parent?: string; - /** - * The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. - */ - resourceVersion?: string; - /** - * Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. - */ - watch?: boolean; - } - - export class Resource$Projects$Locations$Pubsubs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * run.projects.locations.pubsubs.create - * @desc Creates a new pubsub. - * @alias run.projects.locations.pubsubs.create + * run.namespaces.storages.get + * @desc Rpc to get information about a storage. + * @alias run.namespaces.storages.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The project ID or project number in which this pubsub should be created. - * @param {().PubSub} params.requestBody Request body data + * @param {string} params.name The name of the storage being retrieved. If needed, replace {namespace_id} with the project ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - create( - params?: Params$Resource$Projects$Locations$Pubsubs$Create, + get( + params?: Params$Resource$Namespaces$Storages$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Pubsubs$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + get( + params: Params$Resource$Namespaces$Storages$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Pubsubs$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Namespaces$Storages$Get, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pubsubs$Create - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Storages$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pubsubs$Create; + {}) as Params$Resource$Namespaces$Storages$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Pubsubs$Create; + params = {} as Params$Resource$Namespaces$Storages$Get; options = {}; } @@ -6384,69 +5665,76 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+parent}/pubsubs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: ( + rootUrl + '/apis/events.cloud.google.com/v1alpha1/{+name}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.projects.locations.pubsubs.delete - * @desc Rpc to delete a pubsub. - * @alias run.projects.locations.pubsubs.delete + * run.namespaces.storages.list + * @desc Rpc to list storages. + * @alias run.namespaces.storages.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. - * @param {string=} params.kind Cloud Run currently ignores this parameter. - * @param {string} params.name The name of the pubsub being deleted. If needed, replace {namespace_id} with the project ID. - * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. + * @param {string=} params.continue Optional encoded string to continue paging. + * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. + * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + * @param {integer=} params.limit The maximum number of records that should be returned. + * @param {string} params.parent The project ID or project number from which the storages should be listed. + * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - delete( - params?: Params$Resource$Projects$Locations$Pubsubs$Delete, + list( + params?: Params$Resource$Namespaces$Storages$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Pubsubs$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + list( + params: Params$Resource$Namespaces$Storages$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Pubsubs$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Namespaces$Storages$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pubsubs$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Storages$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pubsubs$Delete; + {}) as Params$Resource$Namespaces$Storages$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Pubsubs$Delete; + params = {} as Params$Resource$Namespaces$Storages$List; options = {}; } @@ -6459,63 +5747,67 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: ( + rootUrl + + '/apis/events.cloud.google.com/v1alpha1/{+parent}/storages' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.projects.locations.pubsubs.get - * @desc Rpc to get information about a pubsub. - * @alias run.projects.locations.pubsubs.get + * run.namespaces.storages.replaceStorage + * @desc Rpc to replace a storage. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. + * @alias run.namespaces.storages.replaceStorage * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the pubsub being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {string} params.name The name of the storage being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {().Storage} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - get( - params?: Params$Resource$Projects$Locations$Pubsubs$Get, + replaceStorage( + params?: Params$Resource$Namespaces$Storages$Replacestorage, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Pubsubs$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Pubsubs$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( + ): GaxiosPromise; + replaceStorage( + params: Params$Resource$Namespaces$Storages$Replacestorage, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replaceStorage( + params: Params$Resource$Namespaces$Storages$Replacestorage, + callback: BodyResponseCallback + ): void; + replaceStorage(callback: BodyResponseCallback): void; + replaceStorage( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pubsubs$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Storages$Replacestorage + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pubsubs$Get; + {}) as Params$Resource$Namespaces$Storages$Replacestorage; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Pubsubs$Get; + params = {} as Params$Resource$Namespaces$Storages$Replacestorage; options = {}; } @@ -6528,8 +5820,10 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: ( + rootUrl + '/apis/events.cloud.google.com/v1alpha1/{+name}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', }, options ), @@ -6539,165 +5833,14 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * run.projects.locations.pubsubs.list - * @desc Rpc to list pubsubs. - * @alias run.projects.locations.pubsubs.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.continue Optional encoded string to continue paging. - * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. - * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. - * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. - * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the pubsubs should be listed. - * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. - * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Projects$Locations$Pubsubs$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Pubsubs$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Pubsubs$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Pubsubs$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pubsubs$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Pubsubs$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha1/{+parent}/pubsubs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * run.projects.locations.pubsubs.replacePubSub - * @desc Rpc to replace a pubsub. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. - * @alias run.projects.locations.pubsubs.replacePubSub - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the pubsub being retrieved. If needed, replace {namespace_id} with the project ID. - * @param {().PubSub} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - replacePubSub( - params?: Params$Resource$Projects$Locations$Pubsubs$Replacepubsub, - options?: MethodOptions - ): GaxiosPromise; - replacePubSub( - params: Params$Resource$Projects$Locations$Pubsubs$Replacepubsub, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - replacePubSub( - params: Params$Resource$Projects$Locations$Pubsubs$Replacepubsub, - callback: BodyResponseCallback - ): void; - replacePubSub(callback: BodyResponseCallback): void; - replacePubSub( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Pubsubs$Replacepubsub - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pubsubs$Replacepubsub; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Pubsubs$Replacepubsub; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Pubsubs$Create + export interface Params$Resource$Namespaces$Storages$Create extends StandardParameters { /** * Auth client or API Key for the request @@ -6705,16 +5848,16 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project ID or project number in which this pubsub should be created. + * The project ID or project number in which this storage should be created. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$PubSub; + requestBody?: Schema$Storage; } - export interface Params$Resource$Projects$Locations$Pubsubs$Delete + export interface Params$Resource$Namespaces$Storages$Delete extends StandardParameters { /** * Auth client or API Key for the request @@ -6730,7 +5873,7 @@ export namespace run_v1alpha1 { */ kind?: string; /** - * The name of the pubsub being deleted. If needed, replace {namespace_id} with the project ID. + * The name of the storage being deleted. If needed, replace {namespace_id} with the project ID. */ name?: string; /** @@ -6738,7 +5881,7 @@ export namespace run_v1alpha1 { */ propagationPolicy?: string; } - export interface Params$Resource$Projects$Locations$Pubsubs$Get + export interface Params$Resource$Namespaces$Storages$Get extends StandardParameters { /** * Auth client or API Key for the request @@ -6746,11 +5889,11 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the pubsub being retrieved. If needed, replace {namespace_id} with the project ID. + * The name of the storage being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; } - export interface Params$Resource$Projects$Locations$Pubsubs$List + export interface Params$Resource$Namespaces$Storages$List extends StandardParameters { /** * Auth client or API Key for the request @@ -6778,7 +5921,7 @@ export namespace run_v1alpha1 { */ limit?: number; /** - * The project ID or project number from which the pubsubs should be listed. + * The project ID or project number from which the storages should be listed. */ parent?: string; /** @@ -6790,7 +5933,7 @@ export namespace run_v1alpha1 { */ watch?: boolean; } - export interface Params$Resource$Projects$Locations$Pubsubs$Replacepubsub + export interface Params$Resource$Namespaces$Storages$Replacestorage extends StandardParameters { /** * Auth client or API Key for the request @@ -6798,66 +5941,63 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the pubsub being retrieved. If needed, replace {namespace_id} with the project ID. + * The name of the storage being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; /** * Request body metadata */ - requestBody?: Schema$PubSub; + requestBody?: Schema$Storage; } - export class Resource$Projects$Locations$Revisions { + export class Resource$Namespaces$Triggers { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * run.projects.locations.revisions.delete - * @desc Rpc to delete a revision. - * @alias run.projects.locations.revisions.delete + * run.namespaces.triggers.create + * @desc Creates a new trigger. + * @alias run.namespaces.triggers.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. - * @param {string=} params.kind Cloud Run currently ignores this parameter. - * @param {string} params.name The name of the revision being deleted. If needed, replace {namespace_id} with the project ID. - * @param {boolean=} params.orphanDependents Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. - * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. + * @param {string} params.parent The project ID or project number in which this trigger should be created. + * @param {().Trigger} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - delete( - params?: Params$Resource$Projects$Locations$Revisions$Delete, + create( + params?: Params$Resource$Namespaces$Triggers$Create, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Revisions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + create( + params: Params$Resource$Namespaces$Triggers$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Revisions$Delete, - callback: BodyResponseCallback + create( + params: Params$Resource$Namespaces$Triggers$Create, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Revisions$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Triggers$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Revisions$Delete; + {}) as Params$Resource$Namespaces$Triggers$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Revisions$Delete; + params = {} as Params$Resource$Namespaces$Triggers$Create; options = {}; } @@ -6870,63 +6010,139 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: ( + rootUrl + '/apis/eventing.knative.dev/v1alpha1/{+parent}/triggers' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.projects.locations.revisions.get - * @desc Rpc to get information about a revision. - * @alias run.projects.locations.revisions.get + * run.namespaces.triggers.delete + * @desc Rpc to delete a trigger. + * @alias run.namespaces.triggers.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the revision being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. + * @param {string=} params.kind Cloud Run currently ignores this parameter. + * @param {string} params.name The name of the trigger being deleted. If needed, replace {namespace_id} with the project ID. + * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - get( - params?: Params$Resource$Projects$Locations$Revisions$Get, + delete( + params?: Params$Resource$Namespaces$Triggers$Delete, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Revisions$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Revisions$Get, - callback: BodyResponseCallback + ): GaxiosPromise; + delete( + params: Params$Resource$Namespaces$Triggers$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Namespaces$Triggers$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Namespaces$Triggers$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Triggers$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$Triggers$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/apis/eventing.knative.dev/v1alpha1/{+name}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.namespaces.triggers.get + * @desc Rpc to get information about a trigger. + * @alias run.namespaces.triggers.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the trigger being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Namespaces$Triggers$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Namespaces$Triggers$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Namespaces$Triggers$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Revisions$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Triggers$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Revisions$Get; + {}) as Params$Resource$Namespaces$Triggers$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Revisions$Get; + params = {} as Params$Resource$Namespaces$Triggers$Get; options = {}; } @@ -6939,7 +6155,9 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: ( + rootUrl + '/apis/eventing.knative.dev/v1alpha1/{+name}' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options @@ -6950,16 +6168,16 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.projects.locations.revisions.list - * @desc Rpc to list revisions. - * @alias run.projects.locations.revisions.list + * run.namespaces.triggers.list + * @desc Rpc to list triggers. + * @alias run.namespaces.triggers.list * @memberOf! () * * @param {object} params Parameters for request @@ -6968,7 +6186,7 @@ export namespace run_v1alpha1 { * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the revisions should be listed. + * @param {string} params.parent The project ID or project number from which the triggers should be listed. * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6976,37 +6194,37 @@ export namespace run_v1alpha1 { * @return {object} Request object */ list( - params?: Params$Resource$Projects$Locations$Revisions$List, + params?: Params$Resource$Namespaces$Triggers$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Revisions$List, + params: Params$Resource$Namespaces$Triggers$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Revisions$List, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Triggers$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Revisions$List - | BodyResponseCallback, + | Params$Resource$Namespaces$Triggers$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Revisions$List; + {}) as Params$Resource$Namespaces$Triggers$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Revisions$List; + params = {} as Params$Resource$Namespaces$Triggers$List; options = {}; } @@ -7019,10 +6237,9 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+parent}/revisions').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/apis/eventing.knative.dev/v1alpha1/{+parent}/triggers' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options @@ -7033,14 +6250,103 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); + } + } + + /** + * run.namespaces.triggers.replaceTrigger + * @desc Rpc to replace a trigger. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. + * @alias run.namespaces.triggers.replaceTrigger + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the trigger being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {().Trigger} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + replaceTrigger( + params?: Params$Resource$Namespaces$Triggers$Replacetrigger, + options?: MethodOptions + ): GaxiosPromise; + replaceTrigger( + params: Params$Resource$Namespaces$Triggers$Replacetrigger, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replaceTrigger( + params: Params$Resource$Namespaces$Triggers$Replacetrigger, + callback: BodyResponseCallback + ): void; + replaceTrigger(callback: BodyResponseCallback): void; + replaceTrigger( + paramsOrCallback?: + | Params$Resource$Namespaces$Triggers$Replacetrigger + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Triggers$Replacetrigger; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$Triggers$Replacetrigger; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/apis/eventing.knative.dev/v1alpha1/{+name}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Revisions$Delete + export interface Params$Resource$Namespaces$Triggers$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The project ID or project number in which this trigger should be created. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Trigger; + } + export interface Params$Resource$Namespaces$Triggers$Delete extends StandardParameters { /** * Auth client or API Key for the request @@ -7056,19 +6362,15 @@ export namespace run_v1alpha1 { */ kind?: string; /** - * The name of the revision being deleted. If needed, replace {namespace_id} with the project ID. + * The name of the trigger being deleted. If needed, replace {namespace_id} with the project ID. */ name?: string; - /** - * Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. - */ - orphanDependents?: boolean; /** * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. */ propagationPolicy?: string; } - export interface Params$Resource$Projects$Locations$Revisions$Get + export interface Params$Resource$Namespaces$Triggers$Get extends StandardParameters { /** * Auth client or API Key for the request @@ -7076,11 +6378,11 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the revision being retrieved. If needed, replace {namespace_id} with the project ID. + * The name of the trigger being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; } - export interface Params$Resource$Projects$Locations$Revisions$List + export interface Params$Resource$Namespaces$Triggers$List extends StandardParameters { /** * Auth client or API Key for the request @@ -7108,7 +6410,7 @@ export namespace run_v1alpha1 { */ limit?: number; /** - * The project ID or project number from which the revisions should be listed. + * The project ID or project number from which the triggers should be listed. */ parent?: string; /** @@ -7120,53 +6422,118 @@ export namespace run_v1alpha1 { */ watch?: boolean; } + export interface Params$Resource$Namespaces$Triggers$Replacetrigger + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - export class Resource$Projects$Locations$Routes { + /** + * The name of the trigger being retrieved. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Trigger; + } + + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + } + } + + export class Resource$Projects$Locations { context: APIRequestContext; + authorizeddomains: Resource$Projects$Locations$Authorizeddomains; + cloudauditlogs: Resource$Projects$Locations$Cloudauditlogs; + configurations: Resource$Projects$Locations$Configurations; + domainmappings: Resource$Projects$Locations$Domainmappings; + eventtypes: Resource$Projects$Locations$Eventtypes; + pubsubs: Resource$Projects$Locations$Pubsubs; + revisions: Resource$Projects$Locations$Revisions; + routes: Resource$Projects$Locations$Routes; + services: Resource$Projects$Locations$Services; + storages: Resource$Projects$Locations$Storages; + triggers: Resource$Projects$Locations$Triggers; constructor(context: APIRequestContext) { this.context = context; + this.authorizeddomains = new Resource$Projects$Locations$Authorizeddomains( + this.context + ); + this.cloudauditlogs = new Resource$Projects$Locations$Cloudauditlogs( + this.context + ); + this.configurations = new Resource$Projects$Locations$Configurations( + this.context + ); + this.domainmappings = new Resource$Projects$Locations$Domainmappings( + this.context + ); + this.eventtypes = new Resource$Projects$Locations$Eventtypes( + this.context + ); + this.pubsubs = new Resource$Projects$Locations$Pubsubs(this.context); + this.revisions = new Resource$Projects$Locations$Revisions(this.context); + this.routes = new Resource$Projects$Locations$Routes(this.context); + this.services = new Resource$Projects$Locations$Services(this.context); + this.storages = new Resource$Projects$Locations$Storages(this.context); + this.triggers = new Resource$Projects$Locations$Triggers(this.context); } /** - * run.projects.locations.routes.get - * @desc Rpc to get information about a route. - * @alias run.projects.locations.routes.get + * run.projects.locations.list + * @desc Lists information about the supported locations for this service. + * @alias run.projects.locations.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the route being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {string=} params.filter The standard list filter. + * @param {string} params.name The resource that owns the locations collection, if applicable. + * @param {integer=} params.pageSize The standard list page size. + * @param {string=} params.pageToken The standard list page token. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - get( - params?: Params$Resource$Projects$Locations$Routes$Get, + list( + params?: Params$Resource$Projects$Locations$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Routes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Routes$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$List, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Routes$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Projects$Locations$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Routes$Get; + {}) as Params$Resource$Projects$Locations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Routes$Get; + params = {} as Params$Resource$Projects$Locations$List; options = {}; } @@ -7179,7 +6546,10 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha1/{+name}/locations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', }, options @@ -7190,61 +6560,92 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$List + extends StandardParameters { /** - * run.projects.locations.routes.list - * @desc Rpc to list routes. - * @alias run.projects.locations.routes.list + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The standard list filter. + */ + filter?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Authorizeddomains { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * run.projects.locations.authorizeddomains.list + * @desc RPC to list authorized domains. + * @alias run.projects.locations.authorizeddomains.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.continue Optional encoded string to continue paging. - * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. - * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. - * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. - * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the routes should be listed. - * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. - * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + * @param {integer=} params.pageSize Maximum results to return per page. + * @param {string=} params.pageToken Continuation token for fetching the next page of results. + * @param {string} params.parent Name of the parent Application resource. Example: `apps/myapp`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list( - params?: Params$Resource$Projects$Locations$Routes$List, + params?: Params$Resource$Projects$Locations$Authorizeddomains$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Routes$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Authorizeddomains$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Routes$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Authorizeddomains$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Routes$List - | BodyResponseCallback, + | Params$Resource$Projects$Locations$Authorizeddomains$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Routes$List; + {}) as Params$Resource$Projects$Locations$Authorizeddomains$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Routes$List; + params = {} as Params$Resource$Projects$Locations$Authorizeddomains$List; options = {}; } @@ -7257,7 +6658,7 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+parent}/routes').replace( + url: (rootUrl + '/v1alpha1/{+parent}/authorizeddomains').replace( /([^:]\/)\/+/g, '$1' ), @@ -7271,26 +6672,19 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, + callback + ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Routes$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the route being retrieved. If needed, replace {namespace_id} with the project ID. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Routes$List + export interface Params$Resource$Projects$Locations$Authorizeddomains$List extends StandardParameters { /** * Auth client or API Key for the request @@ -7298,86 +6692,68 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional encoded string to continue paging. + * Maximum results to return per page. */ - continue?: string; + pageSize?: number; /** - * Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + * Continuation token for fetching the next page of results. */ - fieldSelector?: string; + pageToken?: string; /** - * Not currently used by Cloud Run. + * Name of the parent Application resource. Example: `apps/myapp`. */ - includeUninitialized?: boolean; + parent?: string; + } + + export class Resource$Projects$Locations$Cloudauditlogs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + /** - * Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. - */ - labelSelector?: string; - /** - * The maximum number of records that should be returned. - */ - limit?: number; - /** - * The project ID or project number from which the routes should be listed. - */ - parent?: string; - /** - * The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. - */ - resourceVersion?: string; - /** - * Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. - */ - watch?: boolean; - } - - export class Resource$Projects$Locations$Services { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * run.projects.locations.services.create - * @desc Rpc to create a service. - * @alias run.projects.locations.services.create - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent The project ID or project number in which this service should be created. - * @param {().Service} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object + * run.projects.locations.cloudauditlogs.create + * @desc Creates a new cloudauditlog. + * @alias run.projects.locations.cloudauditlogs.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The project ID or project number in which this cloudauditlog should be created. + * @param {().CloudAuditLog} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object */ create( - params?: Params$Resource$Projects$Locations$Services$Create, + params?: Params$Resource$Projects$Locations$Cloudauditlogs$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Services$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Cloudauditlogs$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Services$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Cloudauditlogs$Create, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Services$Create - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Projects$Locations$Cloudauditlogs$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Services$Create; + {}) as Params$Resource$Projects$Locations$Cloudauditlogs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Services$Create; + params = {} as Params$Resource$Projects$Locations$Cloudauditlogs$Create; options = {}; } @@ -7390,7 +6766,7 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+parent}/services').replace( + url: (rootUrl + '/v1alpha1/{+parent}/cloudauditlogs').replace( /([^:]\/)\/+/g, '$1' ), @@ -7404,56 +6780,55 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.projects.locations.services.delete - * @desc Rpc to delete a service. This will cause the Service to stop serving traffic and will delete the child entities like Routes, Configurations and Revisions. - * @alias run.projects.locations.services.delete + * run.projects.locations.cloudauditlogs.delete + * @desc Rpc to delete a cloudauditlog. + * @alias run.projects.locations.cloudauditlogs.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. * @param {string=} params.kind Cloud Run currently ignores this parameter. - * @param {string} params.name The name of the service being deleted. If needed, replace {namespace_id} with the project ID. - * @param {boolean=} params.orphanDependents Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. + * @param {string} params.name The name of the cloudauditlog being deleted. If needed, replace {namespace_id} with the project ID. * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete( - params?: Params$Resource$Projects$Locations$Services$Delete, + params?: Params$Resource$Projects$Locations$Cloudauditlogs$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Services$Delete, + params: Params$Resource$Projects$Locations$Cloudauditlogs$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Services$Delete, + params: Params$Resource$Projects$Locations$Cloudauditlogs$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Services$Delete + | Params$Resource$Projects$Locations$Cloudauditlogs$Delete | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Services$Delete; + {}) as Params$Resource$Projects$Locations$Cloudauditlogs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Services$Delete; + params = {} as Params$Resource$Projects$Locations$Cloudauditlogs$Delete; options = {}; } @@ -7484,45 +6859,47 @@ export namespace run_v1alpha1 { } /** - * run.projects.locations.services.get - * @desc Rpc to get information about a service. - * @alias run.projects.locations.services.get + * run.projects.locations.cloudauditlogs.get + * @desc Rpc to get information about a cloudauditlog. + * @alias run.projects.locations.cloudauditlogs.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the service being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {string} params.name The name of the cloudauditlog being retrieved. If needed, replace {namespace_id} with the project ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get( - params?: Params$Resource$Projects$Locations$Services$Get, + params?: Params$Resource$Projects$Locations$Cloudauditlogs$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Services$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Cloudauditlogs$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Services$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Cloudauditlogs$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Services$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Projects$Locations$Cloudauditlogs$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Services$Get; + {}) as Params$Resource$Projects$Locations$Cloudauditlogs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Services$Get; + params = {} as Params$Resource$Projects$Locations$Cloudauditlogs$Get; options = {}; } @@ -7546,53 +6923,65 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.projects.locations.services.getIamPolicy - * @desc Get the IAM Access Control policy currently in effect for the given Cloud Run service. This result does not include any inherited policies. - * @alias run.projects.locations.services.getIamPolicy + * run.projects.locations.cloudauditlogs.list + * @desc Rpc to list cloudauditlogs. + * @alias run.projects.locations.cloudauditlogs.list * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. - * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. + * @param {string=} params.continue Optional encoded string to continue paging. + * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. + * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + * @param {integer=} params.limit The maximum number of records that should be returned. + * @param {string} params.parent The project ID or project number from which the cloudauditlogs should be listed. + * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - getIamPolicy( - params?: Params$Resource$Projects$Locations$Services$Getiampolicy, + list( + params?: Params$Resource$Projects$Locations$Cloudauditlogs$List, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Services$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Cloudauditlogs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Services$Getiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Cloudauditlogs$List, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Services$Getiampolicy - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Projects$Locations$Cloudauditlogs$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Services$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Cloudauditlogs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Services$Getiampolicy; + params = {} as Params$Resource$Projects$Locations$Cloudauditlogs$List; options = {}; } @@ -7605,7 +6994,7 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1alpha1/{+parent}/cloudauditlogs').replace( /([^:]\/)\/+/g, '$1' ), @@ -7614,68 +7003,2872 @@ export namespace run_v1alpha1 { options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, + callback + ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.projects.locations.services.list - * @desc Rpc to list services. - * @alias run.projects.locations.services.list + * run.projects.locations.cloudauditlogs.replaceCloudAuditLog + * @desc Rpc to replace a cloudauditlog. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. + * @alias run.projects.locations.cloudauditlogs.replaceCloudAuditLog * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.continue Optional encoded string to continue paging. - * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. - * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. - * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. - * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the services should be listed. - * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. - * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + * @param {string} params.name The name of the cloudauditlog being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {().CloudAuditLog} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - list( - params?: Params$Resource$Projects$Locations$Services$List, + replaceCloudAuditLog( + params?: Params$Resource$Projects$Locations$Cloudauditlogs$Replacecloudauditlog, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Services$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + replaceCloudAuditLog( + params: Params$Resource$Projects$Locations$Cloudauditlogs$Replacecloudauditlog, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Services$List, - callback: BodyResponseCallback + replaceCloudAuditLog( + params: Params$Resource$Projects$Locations$Cloudauditlogs$Replacecloudauditlog, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + replaceCloudAuditLog( + callback: BodyResponseCallback + ): void; + replaceCloudAuditLog( paramsOrCallback?: - | Params$Resource$Projects$Locations$Services$List - | BodyResponseCallback, + | Params$Resource$Projects$Locations$Cloudauditlogs$Replacecloudauditlog + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cloudauditlogs$Replacecloudauditlog; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Cloudauditlogs$Replacecloudauditlog; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Cloudauditlogs$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The project ID or project number in which this cloudauditlog should be created. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CloudAuditLog; + } + export interface Params$Resource$Projects$Locations$Cloudauditlogs$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Cloud Run currently ignores this parameter. + */ + apiVersion?: string; + /** + * Cloud Run currently ignores this parameter. + */ + kind?: string; + /** + * The name of the cloudauditlog being deleted. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + /** + * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. + */ + propagationPolicy?: string; + } + export interface Params$Resource$Projects$Locations$Cloudauditlogs$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the cloudauditlog being retrieved. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Cloudauditlogs$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional encoded string to continue paging. + */ + continue?: string; + /** + * Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + */ + fieldSelector?: string; + /** + * Not currently used by Cloud Run. + */ + includeUninitialized?: boolean; + /** + * Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + */ + labelSelector?: string; + /** + * The maximum number of records that should be returned. + */ + limit?: number; + /** + * The project ID or project number from which the cloudauditlogs should be listed. + */ + parent?: string; + /** + * The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + */ + resourceVersion?: string; + /** + * Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + */ + watch?: boolean; + } + export interface Params$Resource$Projects$Locations$Cloudauditlogs$Replacecloudauditlog + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the cloudauditlog being retrieved. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CloudAuditLog; + } + + export class Resource$Projects$Locations$Configurations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * run.projects.locations.configurations.get + * @desc Rpc to get information about a configuration. + * @alias run.projects.locations.configurations.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the configuration being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Projects$Locations$Configurations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Configurations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Configurations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Configurations$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Configurations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Configurations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.configurations.list + * @desc Rpc to list configurations. + * @alias run.projects.locations.configurations.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.continue Optional encoded string to continue paging. + * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. + * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + * @param {integer=} params.limit The maximum number of records that should be returned. + * @param {string} params.parent The project ID or project number from which the configurations should be listed. + * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$Locations$Configurations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Configurations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Configurations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Configurations$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Configurations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Configurations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/configurations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Configurations$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the configuration being retrieved. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Configurations$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional encoded string to continue paging. + */ + continue?: string; + /** + * Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + */ + fieldSelector?: string; + /** + * Not currently used by Cloud Run. + */ + includeUninitialized?: boolean; + /** + * Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + */ + labelSelector?: string; + /** + * The maximum number of records that should be returned. + */ + limit?: number; + /** + * The project ID or project number from which the configurations should be listed. + */ + parent?: string; + /** + * The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + */ + resourceVersion?: string; + /** + * Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + */ + watch?: boolean; + } + + export class Resource$Projects$Locations$Domainmappings { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * run.projects.locations.domainmappings.create + * @desc Creates a new domain mapping. + * @alias run.projects.locations.domainmappings.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The project ID or project number in which this domain mapping should be created. + * @param {().DomainMapping} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params?: Params$Resource$Projects$Locations$Domainmappings$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Domainmappings$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Domainmappings$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Domainmappings$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Domainmappings$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Domainmappings$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/domainmappings').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.domainmappings.delete + * @desc Rpc to delete a domain mapping. + * @alias run.projects.locations.domainmappings.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. + * @param {string=} params.kind Cloud Run currently ignores this parameter. + * @param {string} params.name The name of the domain mapping being deleted. If needed, replace {namespace_id} with the project ID. + * @param {boolean=} params.orphanDependents Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. + * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Projects$Locations$Domainmappings$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Domainmappings$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Domainmappings$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Domainmappings$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Domainmappings$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Domainmappings$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.domainmappings.get + * @desc Rpc to get information about a domain mapping. + * @alias run.projects.locations.domainmappings.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the domain mapping being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Projects$Locations$Domainmappings$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Domainmappings$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Domainmappings$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Domainmappings$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Domainmappings$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Domainmappings$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.domainmappings.list + * @desc Rpc to list domain mappings. + * @alias run.projects.locations.domainmappings.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.continue Optional encoded string to continue paging. + * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. + * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + * @param {integer=} params.limit The maximum number of records that should be returned. + * @param {string} params.parent The project ID or project number from which the domain mappings should be listed. + * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$Locations$Domainmappings$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Domainmappings$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Domainmappings$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Domainmappings$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Domainmappings$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Domainmappings$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/domainmappings').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Domainmappings$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The project ID or project number in which this domain mapping should be created. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DomainMapping; + } + export interface Params$Resource$Projects$Locations$Domainmappings$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Cloud Run currently ignores this parameter. + */ + apiVersion?: string; + /** + * Cloud Run currently ignores this parameter. + */ + kind?: string; + /** + * The name of the domain mapping being deleted. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + /** + * Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. + */ + orphanDependents?: boolean; + /** + * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. + */ + propagationPolicy?: string; + } + export interface Params$Resource$Projects$Locations$Domainmappings$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the domain mapping being retrieved. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Domainmappings$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional encoded string to continue paging. + */ + continue?: string; + /** + * Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + */ + fieldSelector?: string; + /** + * Not currently used by Cloud Run. + */ + includeUninitialized?: boolean; + /** + * Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + */ + labelSelector?: string; + /** + * The maximum number of records that should be returned. + */ + limit?: number; + /** + * The project ID or project number from which the domain mappings should be listed. + */ + parent?: string; + /** + * The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + */ + resourceVersion?: string; + /** + * Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + */ + watch?: boolean; + } + + export class Resource$Projects$Locations$Eventtypes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * run.projects.locations.eventtypes.get + * @desc Rpc to get information about an EventType. + * @alias run.projects.locations.eventtypes.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the trigger being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Projects$Locations$Eventtypes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Eventtypes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Eventtypes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Eventtypes$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Eventtypes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Eventtypes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.eventtypes.list + * @desc Rpc to list EventTypes. + * @alias run.projects.locations.eventtypes.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.continue Optional encoded string to continue paging. + * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. + * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + * @param {integer=} params.limit The maximum number of records that should be returned. + * @param {string} params.parent The project ID or project number from which the EventTypes should be listed. + * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$Locations$Eventtypes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Eventtypes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Eventtypes$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Eventtypes$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Eventtypes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Eventtypes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/eventtypes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Eventtypes$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the trigger being retrieved. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Eventtypes$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional encoded string to continue paging. + */ + continue?: string; + /** + * Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + */ + fieldSelector?: string; + /** + * Not currently used by Cloud Run. + */ + includeUninitialized?: boolean; + /** + * Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + */ + labelSelector?: string; + /** + * The maximum number of records that should be returned. + */ + limit?: number; + /** + * The project ID or project number from which the EventTypes should be listed. + */ + parent?: string; + /** + * The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + */ + resourceVersion?: string; + /** + * Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + */ + watch?: boolean; + } + + export class Resource$Projects$Locations$Pubsubs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * run.projects.locations.pubsubs.create + * @desc Creates a new pubsub. + * @alias run.projects.locations.pubsubs.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The project ID or project number in which this pubsub should be created. + * @param {().PubSub} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params?: Params$Resource$Projects$Locations$Pubsubs$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Pubsubs$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Pubsubs$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Pubsubs$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Pubsubs$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Pubsubs$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/pubsubs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.pubsubs.delete + * @desc Rpc to delete a pubsub. + * @alias run.projects.locations.pubsubs.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. + * @param {string=} params.kind Cloud Run currently ignores this parameter. + * @param {string} params.name The name of the pubsub being deleted. If needed, replace {namespace_id} with the project ID. + * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Projects$Locations$Pubsubs$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Pubsubs$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Pubsubs$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Pubsubs$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Pubsubs$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Pubsubs$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.pubsubs.get + * @desc Rpc to get information about a pubsub. + * @alias run.projects.locations.pubsubs.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the pubsub being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Projects$Locations$Pubsubs$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Pubsubs$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Pubsubs$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Pubsubs$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Pubsubs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Pubsubs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.pubsubs.list + * @desc Rpc to list pubsubs. + * @alias run.projects.locations.pubsubs.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.continue Optional encoded string to continue paging. + * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. + * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + * @param {integer=} params.limit The maximum number of records that should be returned. + * @param {string} params.parent The project ID or project number from which the pubsubs should be listed. + * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$Locations$Pubsubs$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Pubsubs$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Pubsubs$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Pubsubs$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Pubsubs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Pubsubs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/pubsubs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.pubsubs.replacePubSub + * @desc Rpc to replace a pubsub. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. + * @alias run.projects.locations.pubsubs.replacePubSub + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the pubsub being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {().PubSub} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + replacePubSub( + params?: Params$Resource$Projects$Locations$Pubsubs$Replacepubsub, + options?: MethodOptions + ): GaxiosPromise; + replacePubSub( + params: Params$Resource$Projects$Locations$Pubsubs$Replacepubsub, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replacePubSub( + params: Params$Resource$Projects$Locations$Pubsubs$Replacepubsub, + callback: BodyResponseCallback + ): void; + replacePubSub(callback: BodyResponseCallback): void; + replacePubSub( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Pubsubs$Replacepubsub + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Pubsubs$Replacepubsub; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Pubsubs$Replacepubsub; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Pubsubs$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The project ID or project number in which this pubsub should be created. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PubSub; + } + export interface Params$Resource$Projects$Locations$Pubsubs$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Cloud Run currently ignores this parameter. + */ + apiVersion?: string; + /** + * Cloud Run currently ignores this parameter. + */ + kind?: string; + /** + * The name of the pubsub being deleted. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + /** + * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. + */ + propagationPolicy?: string; + } + export interface Params$Resource$Projects$Locations$Pubsubs$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the pubsub being retrieved. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Pubsubs$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional encoded string to continue paging. + */ + continue?: string; + /** + * Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + */ + fieldSelector?: string; + /** + * Not currently used by Cloud Run. + */ + includeUninitialized?: boolean; + /** + * Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + */ + labelSelector?: string; + /** + * The maximum number of records that should be returned. + */ + limit?: number; + /** + * The project ID or project number from which the pubsubs should be listed. + */ + parent?: string; + /** + * The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + */ + resourceVersion?: string; + /** + * Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + */ + watch?: boolean; + } + export interface Params$Resource$Projects$Locations$Pubsubs$Replacepubsub + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the pubsub being retrieved. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PubSub; + } + + export class Resource$Projects$Locations$Revisions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * run.projects.locations.revisions.delete + * @desc Rpc to delete a revision. + * @alias run.projects.locations.revisions.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. + * @param {string=} params.kind Cloud Run currently ignores this parameter. + * @param {string} params.name The name of the revision being deleted. If needed, replace {namespace_id} with the project ID. + * @param {boolean=} params.orphanDependents Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. + * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Projects$Locations$Revisions$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Revisions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Revisions$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Revisions$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Revisions$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Revisions$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.revisions.get + * @desc Rpc to get information about a revision. + * @alias run.projects.locations.revisions.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the revision being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Projects$Locations$Revisions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Revisions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Revisions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Revisions$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Revisions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Revisions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.revisions.list + * @desc Rpc to list revisions. + * @alias run.projects.locations.revisions.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.continue Optional encoded string to continue paging. + * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. + * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + * @param {integer=} params.limit The maximum number of records that should be returned. + * @param {string} params.parent The project ID or project number from which the revisions should be listed. + * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$Locations$Revisions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Revisions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Revisions$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Revisions$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Revisions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Revisions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/revisions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Revisions$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Cloud Run currently ignores this parameter. + */ + apiVersion?: string; + /** + * Cloud Run currently ignores this parameter. + */ + kind?: string; + /** + * The name of the revision being deleted. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + /** + * Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. + */ + orphanDependents?: boolean; + /** + * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. + */ + propagationPolicy?: string; + } + export interface Params$Resource$Projects$Locations$Revisions$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the revision being retrieved. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Revisions$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional encoded string to continue paging. + */ + continue?: string; + /** + * Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + */ + fieldSelector?: string; + /** + * Not currently used by Cloud Run. + */ + includeUninitialized?: boolean; + /** + * Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + */ + labelSelector?: string; + /** + * The maximum number of records that should be returned. + */ + limit?: number; + /** + * The project ID or project number from which the revisions should be listed. + */ + parent?: string; + /** + * The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + */ + resourceVersion?: string; + /** + * Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + */ + watch?: boolean; + } + + export class Resource$Projects$Locations$Routes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * run.projects.locations.routes.get + * @desc Rpc to get information about a route. + * @alias run.projects.locations.routes.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the route being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Projects$Locations$Routes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Routes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Routes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Routes$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Routes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Routes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.routes.list + * @desc Rpc to list routes. + * @alias run.projects.locations.routes.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.continue Optional encoded string to continue paging. + * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. + * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + * @param {integer=} params.limit The maximum number of records that should be returned. + * @param {string} params.parent The project ID or project number from which the routes should be listed. + * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$Locations$Routes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Routes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Routes$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Routes$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Routes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Routes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/routes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Routes$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the route being retrieved. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Routes$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional encoded string to continue paging. + */ + continue?: string; + /** + * Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + */ + fieldSelector?: string; + /** + * Not currently used by Cloud Run. + */ + includeUninitialized?: boolean; + /** + * Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + */ + labelSelector?: string; + /** + * The maximum number of records that should be returned. + */ + limit?: number; + /** + * The project ID or project number from which the routes should be listed. + */ + parent?: string; + /** + * The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + */ + resourceVersion?: string; + /** + * Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + */ + watch?: boolean; + } + + export class Resource$Projects$Locations$Services { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * run.projects.locations.services.create + * @desc Rpc to create a service. + * @alias run.projects.locations.services.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The project ID or project number in which this service should be created. + * @param {().Service} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params?: Params$Resource$Projects$Locations$Services$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Services$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Services$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Services$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/services').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.services.delete + * @desc Rpc to delete a service. This will cause the Service to stop serving traffic and will delete the child entities like Routes, Configurations and Revisions. + * @alias run.projects.locations.services.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. + * @param {string=} params.kind Cloud Run currently ignores this parameter. + * @param {string} params.name The name of the service being deleted. If needed, replace {namespace_id} with the project ID. + * @param {boolean=} params.orphanDependents Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. + * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Projects$Locations$Services$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Services$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Services$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Services$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.services.get + * @desc Rpc to get information about a service. + * @alias run.projects.locations.services.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the service being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Projects$Locations$Services$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Services$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Services$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Services$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.services.getIamPolicy + * @desc Get the IAM Access Control policy currently in effect for the given Cloud Run service. This result does not include any inherited policies. + * @alias run.projects.locations.services.getIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIamPolicy( + params?: Params$Resource$Projects$Locations$Services$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Services$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Services$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Services$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.services.list + * @desc Rpc to list services. + * @alias run.projects.locations.services.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.continue Optional encoded string to continue paging. + * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. + * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + * @param {integer=} params.limit The maximum number of records that should be returned. + * @param {string} params.parent The project ID or project number from which the services should be listed. + * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$Locations$Services$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Services$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Services$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Services$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/services').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.services.replaceService + * @desc Rpc to replace a service. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. + * @alias run.projects.locations.services.replaceService + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the service being replaced. If needed, replace {namespace_id} with the project ID. + * @param {().Service} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + replaceService( + params?: Params$Resource$Projects$Locations$Services$Replaceservice, + options?: MethodOptions + ): GaxiosPromise; + replaceService( + params: Params$Resource$Projects$Locations$Services$Replaceservice, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replaceService( + params: Params$Resource$Projects$Locations$Services$Replaceservice, + callback: BodyResponseCallback + ): void; + replaceService(callback: BodyResponseCallback): void; + replaceService( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Replaceservice + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Replaceservice; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Services$Replaceservice; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.services.setIamPolicy + * @desc Sets the IAM Access control policy for the specified Service. Overwrites any existing policy. + * @alias run.projects.locations.services.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. + * @param {().SetIamPolicyRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setIamPolicy( + params?: Params$Resource$Projects$Locations$Services$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Services$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Services$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Services$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.services.testIamPermissions + * @desc Returns permissions that a caller has on the specified Project. There are no permissions required for making this API call. + * @alias run.projects.locations.services.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. + * @param {().TestIamPermissionsRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Projects$Locations$Services$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Services$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Services$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Services$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Services$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The project ID or project number in which this service should be created. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Service; + } + export interface Params$Resource$Projects$Locations$Services$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Cloud Run currently ignores this parameter. + */ + apiVersion?: string; + /** + * Cloud Run currently ignores this parameter. + */ + kind?: string; + /** + * The name of the service being deleted. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + /** + * Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. + */ + orphanDependents?: boolean; + /** + * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. + */ + propagationPolicy?: string; + } + export interface Params$Resource$Projects$Locations$Services$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the service being retrieved. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Services$Getiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Services$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional encoded string to continue paging. + */ + continue?: string; + /** + * Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + */ + fieldSelector?: string; + /** + * Not currently used by Cloud Run. + */ + includeUninitialized?: boolean; + /** + * Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + */ + labelSelector?: string; + /** + * The maximum number of records that should be returned. + */ + limit?: number; + /** + * The project ID or project number from which the services should be listed. + */ + parent?: string; + /** + * The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + */ + resourceVersion?: string; + /** + * Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + */ + watch?: boolean; + } + export interface Params$Resource$Projects$Locations$Services$Replaceservice + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the service being replaced. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Service; + } + export interface Params$Resource$Projects$Locations$Services$Setiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Services$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Storages { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * run.projects.locations.storages.create + * @desc Creates a new storage. + * @alias run.projects.locations.storages.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The project ID or project number in which this storage should be created. + * @param {().Storage} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params?: Params$Resource$Projects$Locations$Storages$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Storages$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Storages$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Storages$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Services$List; + {}) as Params$Resource$Projects$Locations$Storages$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Services$List; + params = {} as Params$Resource$Projects$Locations$Storages$Create; options = {}; } @@ -7688,11 +9881,11 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+parent}/services').replace( + url: (rootUrl + '/v1alpha1/{+parent}/storages').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', }, options ), @@ -7702,53 +9895,55 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.projects.locations.services.replaceService - * @desc Rpc to replace a service. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. - * @alias run.projects.locations.services.replaceService + * run.projects.locations.storages.delete + * @desc Rpc to delete a storage. + * @alias run.projects.locations.storages.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the service being replaced. If needed, replace {namespace_id} with the project ID. - * @param {().Service} params.requestBody Request body data + * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. + * @param {string=} params.kind Cloud Run currently ignores this parameter. + * @param {string} params.name The name of the storage being deleted. If needed, replace {namespace_id} with the project ID. + * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - replaceService( - params?: Params$Resource$Projects$Locations$Services$Replaceservice, + delete( + params?: Params$Resource$Projects$Locations$Storages$Delete, options?: MethodOptions - ): GaxiosPromise; - replaceService( - params: Params$Resource$Projects$Locations$Services$Replaceservice, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Storages$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - replaceService( - params: Params$Resource$Projects$Locations$Services$Replaceservice, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Storages$Delete, + callback: BodyResponseCallback ): void; - replaceService(callback: BodyResponseCallback): void; - replaceService( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Services$Replaceservice - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Projects$Locations$Storages$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Services$Replaceservice; + {}) as Params$Resource$Projects$Locations$Storages$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Services$Replaceservice; + params = {} as Params$Resource$Projects$Locations$Storages$Delete; options = {}; } @@ -7762,7 +9957,7 @@ export namespace run_v1alpha1 { options: Object.assign( { url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', + method: 'DELETE', }, options ), @@ -7772,53 +9967,52 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.projects.locations.services.setIamPolicy - * @desc Sets the IAM Access control policy for the specified Service. Overwrites any existing policy. - * @alias run.projects.locations.services.setIamPolicy + * run.projects.locations.storages.get + * @desc Rpc to get information about a storage. + * @alias run.projects.locations.storages.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. - * @param {().SetIamPolicyRequest} params.requestBody Request body data + * @param {string} params.name The name of the storage being retrieved. If needed, replace {namespace_id} with the project ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - setIamPolicy( - params?: Params$Resource$Projects$Locations$Services$Setiampolicy, + get( + params?: Params$Resource$Projects$Locations$Storages$Get, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Services$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Storages$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Services$Setiampolicy, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Storages$Get, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Services$Setiampolicy - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Projects$Locations$Storages$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Services$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Storages$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Services$Setiampolicy; + params = {} as Params$Resource$Projects$Locations$Storages$Get; options = {}; } @@ -7831,73 +10025,74 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.projects.locations.services.testIamPermissions - * @desc Returns permissions that a caller has on the specified Project. There are no permissions required for making this API call. - * @alias run.projects.locations.services.testIamPermissions + * run.projects.locations.storages.list + * @desc Rpc to list storages. + * @alias run.projects.locations.storages.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. - * @param {().TestIamPermissionsRequest} params.requestBody Request body data + * @param {string=} params.continue Optional encoded string to continue paging. + * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. + * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + * @param {integer=} params.limit The maximum number of records that should be returned. + * @param {string} params.parent The project ID or project number from which the storages should be listed. + * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - testIamPermissions( - params?: Params$Resource$Projects$Locations$Services$Testiampermissions, + list( + params?: Params$Resource$Projects$Locations$Storages$List, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Services$Testiampermissions, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Storages$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Services$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Storages$List, + callback: BodyResponseCallback ): void; - testIamPermissions( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Services$Testiampermissions - | BodyResponseCallback, + | Params$Resource$Projects$Locations$Storages$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Services$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Storages$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Services$Testiampermissions; + params = {} as Params$Resource$Projects$Locations$Storages$List; options = {}; } @@ -7910,31 +10105,98 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+resource}:testIamPermissions').replace( + url: (rootUrl + '/v1alpha1/{+parent}/storages').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback - ); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.storages.replaceStorage + * @desc Rpc to replace a storage. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. + * @alias run.projects.locations.storages.replaceStorage + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the storage being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {().Storage} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + replaceStorage( + params?: Params$Resource$Projects$Locations$Storages$Replacestorage, + options?: MethodOptions + ): GaxiosPromise; + replaceStorage( + params: Params$Resource$Projects$Locations$Storages$Replacestorage, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replaceStorage( + params: Params$Resource$Projects$Locations$Storages$Replacestorage, + callback: BodyResponseCallback + ): void; + replaceStorage(callback: BodyResponseCallback): void; + replaceStorage( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Storages$Replacestorage + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Storages$Replacestorage; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Storages$Replacestorage; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Services$Create + export interface Params$Resource$Projects$Locations$Storages$Create extends StandardParameters { /** * Auth client or API Key for the request @@ -7942,16 +10204,16 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project ID or project number in which this service should be created. + * The project ID or project number in which this storage should be created. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$Service; + requestBody?: Schema$Storage; } - export interface Params$Resource$Projects$Locations$Services$Delete + export interface Params$Resource$Projects$Locations$Storages$Delete extends StandardParameters { /** * Auth client or API Key for the request @@ -7967,19 +10229,15 @@ export namespace run_v1alpha1 { */ kind?: string; /** - * The name of the service being deleted. If needed, replace {namespace_id} with the project ID. + * The name of the storage being deleted. If needed, replace {namespace_id} with the project ID. */ name?: string; - /** - * Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. - */ - orphanDependents?: boolean; /** * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. */ propagationPolicy?: string; } - export interface Params$Resource$Projects$Locations$Services$Get + export interface Params$Resource$Projects$Locations$Storages$Get extends StandardParameters { /** * Auth client or API Key for the request @@ -7987,27 +10245,11 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the service being retrieved. If needed, replace {namespace_id} with the project ID. + * The name of the storage being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; } - export interface Params$Resource$Projects$Locations$Services$Getiampolicy - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Services$List + export interface Params$Resource$Projects$Locations$Storages$List extends StandardParameters { /** * Auth client or API Key for the request @@ -8035,7 +10277,7 @@ export namespace run_v1alpha1 { */ limit?: number; /** - * The project ID or project number from which the services should be listed. + * The project ID or project number from which the storages should be listed. */ parent?: string; /** @@ -8047,7 +10289,7 @@ export namespace run_v1alpha1 { */ watch?: boolean; } - export interface Params$Resource$Projects$Locations$Services$Replaceservice + export interface Params$Resource$Projects$Locations$Storages$Replacestorage extends StandardParameters { /** * Auth client or API Key for the request @@ -8055,48 +10297,14 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the service being replaced. If needed, replace {namespace_id} with the project ID. + * The name of the storage being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; /** * Request body metadata */ - requestBody?: Schema$Service; - } - export interface Params$Resource$Projects$Locations$Services$Setiampolicy - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Services$Testiampermissions - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestIamPermissionsRequest; + requestBody?: Schema$Storage; } export class Resource$Projects$Locations$Triggers { diff --git a/src/apis/run/v1beta1.ts b/src/apis/run/v1beta1.ts index 71b1b18f068..021c3c97d25 100644 --- a/src/apis/run/v1beta1.ts +++ b/src/apis/run/v1beta1.ts @@ -159,7 +159,7 @@ export namespace run_v1beta1 { */ apiVersion?: string | null; /** - * The kind of resource, one example is "Storage". + * The kind of resource, in this case always "CustomResourceDefinition". */ kind?: string | null; /** diff --git a/src/apis/runtimeconfig/v1beta1.ts b/src/apis/runtimeconfig/v1beta1.ts index 234cb3b27f8..d6f098ad728 100644 --- a/src/apis/runtimeconfig/v1beta1.ts +++ b/src/apis/runtimeconfig/v1beta1.ts @@ -124,7 +124,7 @@ export namespace runtimeconfig_v1beta1 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -244,19 +244,19 @@ export namespace runtimeconfig_v1beta1 { response?: {[key: string]: any} | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if the incoming policy version does not meet the requirements for modifying the stored policy. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a binding (conditional or unconditional) from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, version compliance checks against the stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } diff --git a/src/apis/surveys/README.md b/src/apis/sasportal/README.md similarity index 78% rename from src/apis/surveys/README.md rename to src/apis/sasportal/README.md index af8d888c534..409b25b5feb 100644 --- a/src/apis/surveys/README.md +++ b/src/apis/sasportal/README.md @@ -1,8 +1,8 @@ Google Inc. logo -# surveys +# sasportal -> Creates and conducts surveys, lists the surveys that an authenticated user owns, and retrieves survey results and information about specified surveys. +> ## Installation @@ -19,17 +19,17 @@ This library can be used in a browser. To prepare a single file bundle, clone th [repository](https://github.com/googleapis/google-api-nodejs-client) and run ```sh -$ cd src/apis/surveys +$ cd src/apis/sasportal $ npm install $ npm run webpack ``` -The generated bundle will be written to `dist/surveys.min.js`. Use it from your HTML file: +The generated bundle will be written to `dist/sasportal.min.js`. Use it from your HTML file: ```html - + ``` diff --git a/src/apis/surveys/index.ts b/src/apis/sasportal/index.ts similarity index 63% rename from src/apis/surveys/index.ts rename to src/apis/sasportal/index.ts index 4863c69ba9d..80c081ff129 100644 --- a/src/apis/surveys/index.ts +++ b/src/apis/sasportal/index.ts @@ -14,19 +14,21 @@ /*! THIS FILE IS AUTO-GENERATED */ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; -import {surveys_v2} from './v2'; +import {sasportal_v1alpha1} from './v1alpha1'; export const VERSIONS = { - v2: surveys_v2.Surveys, + v1alpha1: sasportal_v1alpha1.Sasportal, }; -export function surveys(version: 'v2'): surveys_v2.Surveys; -export function surveys(options: surveys_v2.Options): surveys_v2.Surveys; -export function surveys( +export function sasportal(version: 'v1alpha1'): sasportal_v1alpha1.Sasportal; +export function sasportal( + options: sasportal_v1alpha1.Options +): sasportal_v1alpha1.Sasportal; +export function sasportal( this: GoogleConfigurable, - versionOrOptions: 'v2' | surveys_v2.Options + versionOrOptions: 'v1alpha1' | sasportal_v1alpha1.Options ) { - return getAPI('surveys', versionOrOptions, VERSIONS, this); + return getAPI('sasportal', versionOrOptions, VERSIONS, this); } const auth = new AuthPlus(); diff --git a/src/apis/surveys/package.json b/src/apis/sasportal/package.json similarity index 93% rename from src/apis/surveys/package.json rename to src/apis/sasportal/package.json index 6dbef5bbf3d..b4cfd0321ef 100644 --- a/src/apis/surveys/package.json +++ b/src/apis/sasportal/package.json @@ -1,7 +1,7 @@ { - "name": "@google/surveys", + "name": "@google/sasportal", "version": "0.1.0", - "description": "surveys", + "description": "sasportal", "main": "build/index.js", "types": "build/index.d.ts", "keywords": [ diff --git a/src/apis/searchconsole/tsconfig.json b/src/apis/sasportal/tsconfig.json similarity index 100% rename from src/apis/searchconsole/tsconfig.json rename to src/apis/sasportal/tsconfig.json diff --git a/src/apis/sasportal/v1alpha1.ts b/src/apis/sasportal/v1alpha1.ts new file mode 100644 index 00000000000..117b0959bcc --- /dev/null +++ b/src/apis/sasportal/v1alpha1.ts @@ -0,0 +1,4387 @@ +// Copyright 2019 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, +} from 'google-auth-library'; +import { + GoogleConfigurable, + createAPIRequest, + MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace sasportal_v1alpha1 { + export interface Options extends GlobalOptions { + version: 'v1alpha1'; + } + + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * SAS Portal API + * + * + * + * @example + * const {google} = require('googleapis'); + * const sasportal = google.sasportal('v1alpha1'); + * + * @namespace sasportal + * @type {Function} + * @version v1alpha1 + * @variation v1alpha1 + * @param {object=} options Options for Sasportal + */ + export class Sasportal { + context: APIRequestContext; + customers: Resource$Customers; + installer: Resource$Installer; + nodes: Resource$Nodes; + policies: Resource$Policies; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.customers = new Resource$Customers(this.context); + this.installer = new Resource$Installer(this.context); + this.nodes = new Resource$Nodes(this.context); + this.policies = new Resource$Policies(this.context); + } + } + + /** + * Associates `members` with a `role`. + */ + export interface Schema$SasPortalAssignment { + /** + * The identities the role is assigned to. It can have the following values: * `{user_email}`: An email address that represents a specific Google account. For example: `alice@gmail.com`. * `{group_email}`: An email address that represents a Google group. For example, `viewers@gmail.com`. + */ + members?: string[] | null; + /** + * Required. Role that is assigned to `members`. + */ + role?: string | null; + } + /** + * Request for BulkCreateDevice method. + */ + export interface Schema$SasPortalBulkCreateDeviceRequest { + /** + * Required. A csv with each row representing a [device]. Each row must conform to the regulations described on CreateDeviceRequest's device field. + */ + csv?: string | null; + } + /** + * Response for BulkCreateDevice method. + */ + export interface Schema$SasPortalBulkCreateDeviceResponse { + /** + * Required. The devices that were imported. + */ + devices?: Schema$SasPortalDevice[]; + } + /** + * Request for CreateSignedDevice method. + */ + export interface Schema$SasPortalCreateSignedDeviceRequest { + /** + * Required. JSON Web Token signed using a CPI private key. Payload must be the JSON encoding of the [Device]. + */ + encodedDevice?: string | null; + /** + * Required. Unique installer id (cpiId) from the Certified Professional Installers database. + */ + installerId?: string | null; + } + /** + * Entity representing a SAS customer. + */ + export interface Schema$SasPortalCustomer { + /** + * Required. Name of the organization that the customer entity represents. + */ + displayName?: string | null; + /** + * Output only. Resource name of the customer. + */ + name?: string | null; + /** + * User IDs used by the devices belonging to this customer. + */ + sasUserIds?: string[] | null; + } + export interface Schema$SasPortalDevice { + /** + * Output only. Current configuration of the device as registered to the SAS. + */ + activeConfig?: Schema$SasPortalDeviceConfig; + /** + * Device display name. + */ + displayName?: string | null; + /** + * The FCC identifier of the device. + */ + fccId?: string | null; + /** + * Output only. Grants held by the device. + */ + grants?: Schema$SasPortalDeviceGrant[]; + /** + * Output only. The resource path name. + */ + name?: string | null; + /** + * Configuration of the device, as specified via SAS Portal API. + */ + preloadedConfig?: Schema$SasPortalDeviceConfig; + /** + * A serial number assigned to the device by the device manufacturer. + */ + serialNumber?: string | null; + /** + * Output only. Device state. + */ + state?: string | null; + } + /** + * Information about the device's air interface. + */ + export interface Schema$SasPortalDeviceAirInterface { + /** + * This field specifies the radio access technology that is used for the CBSD. Conditional + */ + radioTechnology?: string | null; + /** + * This field is related to the radioTechnology field and provides the air interface specification that the CBSD is compliant with at the time of registration. Optional + */ + supportedSpec?: string | null; + } + /** + * Information about the device configuration. + */ + export interface Schema$SasPortalDeviceConfig { + /** + * Information about this device's air interface. + */ + airInterface?: Schema$SasPortalDeviceAirInterface; + /** + * The call sign of the device operator. + */ + callSign?: string | null; + /** + * FCC category of the device. + */ + category?: string | null; + /** + * Installation parameters for the device. + */ + installationParams?: Schema$SasPortalInstallationParams; + /** + * Output-only. Whether the configuration has been signed by a CPI. + */ + isSigned?: boolean | null; + /** + * Measurement reporting capabilities of the device. + */ + measurementCapabilities?: string[] | null; + /** + * Information about this device model. + */ + model?: Schema$SasPortalDeviceModel; + /** + * State of the configuration. + */ + state?: string | null; + /** + * Output-only. The last time the device configuration was edited. + */ + updateTime?: string | null; + /** + * Output only. The identifier of a device user. + */ + userId?: string | null; + } + /** + * Device grant. It is an authorization provided by the Spectrum Access System to a device to transmit using specified operating parameters after a successful heartbeat by the device. + */ + export interface Schema$SasPortalDeviceGrant { + /** + * Type of channel used. + */ + channelType?: string | null; + /** + * The expiration time of the grant. + */ + expireTime?: string | null; + /** + * The transmission frequency range. + */ + frequencyRange?: Schema$SasPortalFrequencyRange; + /** + * Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by the grant. The maximum EIRP is in units of dBm/MHz. The value of maxEirp represents the average (RMS) EIRP that would be measured by the procedure defined in FCC part 96.41(e)(3). + */ + maxEirp?: number | null; + /** + * The DPA move lists on which this grant appears. + */ + moveList?: Schema$SasPortalDpaMoveList[]; + /** + * State of the grant. + */ + state?: string | null; + } + /** + * Information about the model of the device. + */ + export interface Schema$SasPortalDeviceModel { + /** + * The firmware version of the device. + */ + firmwareVersion?: string | null; + /** + * The hardware version of the device. + */ + hardwareVersion?: string | null; + /** + * The name of the device model. + */ + name?: string | null; + /** + * The software version of the device. + */ + softwareVersion?: string | null; + /** + * The name of the device vendor. + */ + vendor?: string | null; + } + /** + * An entry in a DPA's move list. + */ + export interface Schema$SasPortalDpaMoveList { + /** + * The ID of the DPA. + */ + dpaId?: string | null; + /** + * The frequency range that the move list affects. + */ + frequencyRange?: Schema$SasPortalFrequencyRange; + } + /** + * 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$SasPortalEmpty {} + /** + * Frequency range from `low_frequency` to `high_frequency`. + */ + export interface Schema$SasPortalFrequencyRange { + /** + * The highest frequency of the frequency range in MHz. + */ + highFrequencyMhz?: number | null; + /** + * The lowest frequency of the frequency range in MHz. + */ + lowFrequencyMhz?: number | null; + } + /** + * Request for GenerateSecret method] [spectrum.sas.portal.v1alpha1.DeviceManager.GenerateSecret]. + */ + export interface Schema$SasPortalGenerateSecretRequest {} + /** + * Response for GenerateSecret method. + */ + export interface Schema$SasPortalGenerateSecretResponse { + /** + * The secret generated by the string and used by [ValidateInstaller] method. + */ + secret?: string | null; + } + /** + * Request message for `GetPolicy` method. + */ + export interface Schema$SasPortalGetPolicyRequest { + /** + * Required. The resource for which the policy is being requested. + */ + resource?: string | null; + } + /** + * Information about the device installation parameters. + */ + export interface Schema$SasPortalInstallationParams { + /** + * Boresight direction of the horizontal plane of the antenna in degrees with respect to true north. The value of this parameter is an integer with a value between 0 and 359 inclusive. A value of 0 degrees means true north; a value of 90 degrees means east. This parameter is optional for Category A devices and conditional for Category B devices. + */ + antennaAzimuth?: number | null; + /** + * 3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This parameter is an unsigned integer having a value between 0 and 360 (degrees) inclusive; it is optional for Category A devices and conditional for Category B devices. + */ + antennaBeamwidth?: number | null; + /** + * Antenna downtilt in degrees and is an integer with a value between -90 and +90 inclusive; a negative value means the antenna is tilted up (above horizontal). This parameter is optional for Category A devices and conditional for Category B devices. + */ + antennaDowntilt?: number | null; + /** + * Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. + */ + antennaGain?: number | null; + /** + * If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets. + */ + antennaModel?: string | null; + /** + * This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category. + */ + eirpCapability?: number | null; + /** + * Device antenna height in meters. When the heightType parameter value is "AGL", the antenna height should be given relative to ground level. When the heightType parameter value is "AMSL", it is given with respect to WGS84 datum. + */ + height?: number | null; + /** + * Specifies how the height is measured. + */ + heightType?: string | null; + /** + * A positive number in meters to indicate accuracy of the device antenna horizontal location. This optional parameter should only be present if its value is less than the FCC requirement of 50 meters. + */ + horizontalAccuracy?: number | null; + /** + * Whether the device antenna is indoor or not. True: indoor. False: outdoor. + */ + indoorDeployment?: boolean | null; + /** + * Latitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator. + */ + latitude?: number | null; + /** + * Longitude of the device antenna location. in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian. + */ + longitude?: number | null; + /** + * A positive number in meters to indicate accuracy of the device antenna vertical location. This optional parameter should only be present if its value is less than the FCC requirement of 3 meters. + */ + verticalAccuracy?: number | null; + } + /** + * Response for `ListCustomers`. + */ + export interface Schema$SasPortalListCustomersResponse { + /** + * The list of customers that match the request. + */ + customers?: Schema$SasPortalCustomer[]; + /** + * A pagination token returned from a previous call to ListCustomers method that indicates from where listing should continue. If the field is missing or empty, it means there are no more customers. + */ + nextPageToken?: string | null; + } + /** + * Response for ListDevices method. + */ + export interface Schema$SasPortalListDevicesResponse { + /** + * The devices that match the request. + */ + devices?: Schema$SasPortalDevice[]; + /** + * A pagination token returned from a previous call to ListDevices method that indicates from where listing should continue. If the field is missing or empty, it means there is no more devices. + */ + nextPageToken?: string | null; + } + /** + * Response for ListNodes method. + */ + export interface Schema$SasPortalListNodesResponse { + /** + * A pagination token returned from a previous call to ListNodes method that indicates from where listing should continue. If the field is missing or empty, it means there is no more nodes. + */ + nextPageToken?: string | null; + /** + * The nodes that match the request. + */ + nodes?: Schema$SasPortalNode[]; + } + /** + * Request for MoveDevice method. + */ + export interface Schema$SasPortalMoveDeviceRequest { + /** + * Required. The name of the new parent resource (Node or Customer) to reparent the device under. + */ + destination?: string | null; + } + /** + * Request for MoveNode method. + */ + export interface Schema$SasPortalMoveNodeRequest { + /** + * Required. The name of the new parent resource node or Customer) to reparent the node under. + */ + destination?: string | null; + } + /** + * The Node. + */ + export interface Schema$SasPortalNode { + /** + * The node's display name. + */ + displayName?: string | null; + /** + * Output only. Resource name. + */ + name?: string | null; + /** + * User ids used by the devices belonging to this node. + */ + sasUserIds?: string[] | null; + } + /** + * This resource represents a long-running operation that is the result of a network API call. + */ + export interface Schema$SasPortalOperation { + /** + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. + */ + done?: boolean | null; + /** + * The error result of the operation in case of failure or cancellation. + */ + error?: Schema$SasPortalStatus; + /** + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + */ + metadata?: {[key: string]: any} | null; + /** + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. + */ + name?: string | null; + /** + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + */ + response?: {[key: string]: any} | null; + } + /** + * Defines an access control policy to the resources. + */ + export interface Schema$SasPortalPolicy { + assignments?: Schema$SasPortalAssignment[]; + /** + * The [etag] is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the [etag] in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An [etag] is returned in the response to [GetPolicy], and systems are expected to put that etag in the request to [SetPolicy] to ensure that their change will be applied to the same version of the policy. If no [etag] is provided in the call to [SetPolicy], then the existing policy is overwritten blindly. + */ + etag?: string | null; + } + /** + * Request message for `SetPolicy` method. + */ + export interface Schema$SasPortalSetPolicyRequest { + /** + * Required. The policy to be applied to the `resource`. + */ + policy?: Schema$SasPortalPolicy; + /** + * Required. The resource for which the policy is being specified. This policy replaces any existing policy. + */ + resource?: string | null; + } + /** + * Request for SignDevice method. + */ + export interface Schema$SasPortalSignDeviceRequest { + /** + * Required. The device to sign. The device fields name, fcc_id and serial_number must be set. + */ + device?: Schema$SasPortalDevice; + } + /** + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + */ + export interface Schema$SasPortalStatus { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number | null; + /** + * A list of messages that carry the error details. There is a common set of message types for APIs to use. + */ + details?: Array<{[key: string]: any}> | null; + /** + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + */ + message?: string | null; + } + /** + * Request message for `TestPermissions` method. + */ + export interface Schema$SasPortalTestPermissionsRequest { + /** + * The set of permissions to check for the `resource`. + */ + permissions?: string[] | null; + /** + * Required. The resource for which the permissions are being requested. + */ + resource?: string | null; + } + /** + * Response message for `TestPermissions` method. + */ + export interface Schema$SasPortalTestPermissionsResponse { + /** + * A set of permissions that the caller is allowed. + */ + permissions?: string[] | null; + } + /** + * Request for UpdateSignedDevice method. + */ + export interface Schema$SasPortalUpdateSignedDeviceRequest { + /** + * Required. The JSON Web Token signed using a CPI private key. Payload must be the JSON encoding of the device. + */ + encodedDevice?: string | null; + /** + * Required. Unique installer ID (CPI ID) from the Certified Professional Installers database. + */ + installerId?: string | null; + } + /** + * Request for ValidateInstaller method. + */ + export interface Schema$SasPortalValidateInstallerRequest { + /** + * Required. JSON Web Token signed using a CPI private key. Payload must include a "secret" claim whose value is the secret. + */ + encodedSecret?: string | null; + /** + * Required. Unique installer id (cpiId) from the Certified Professional Installers database. + */ + installerId?: string | null; + /** + * Required. Secret returned by the GenerateSecret method. + */ + secret?: string | null; + } + /** + * Response for ValidateInstaller method] [spectrum.sas.portal.v1alpha1.DeviceManager.ValidateInstaller]. + */ + export interface Schema$SasPortalValidateInstallerResponse {} + + export class Resource$Customers { + context: APIRequestContext; + devices: Resource$Customers$Devices; + nodes: Resource$Customers$Nodes; + constructor(context: APIRequestContext) { + this.context = context; + this.devices = new Resource$Customers$Devices(this.context); + this.nodes = new Resource$Customers$Nodes(this.context); + } + + /** + * sasportal.customers.get + * @desc Returns a requested customer. + * @alias sasportal.customers.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the customer. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Customers$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Customers$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Customers$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Customers$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Customers$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sasportal.customers.list + * @desc Returns a list of requested customers. + * @alias sasportal.customers.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize The maximum number of customers to return in the response. + * @param {string=} params.pageToken A pagination token returned from a previous call to ListCustomers method that indicates where this listing should continue from. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Customers$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Customers$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Customers$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Customers$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Customers$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/customers').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * sasportal.customers.patch + * @desc Updates an existing customer. + * @alias sasportal.customers.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Output only. Resource name of the customer. + * @param {string=} params.updateMask Fields to be updated. + * @param {().SasPortalCustomer} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Customers$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Customers$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Customers$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Customers$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Customers$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Customers$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the customer. + */ + name?: string; + } + export interface Params$Resource$Customers$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The maximum number of customers to return in the response. + */ + pageSize?: number; + /** + * A pagination token returned from a previous call to ListCustomers method that indicates where this listing should continue from. + */ + pageToken?: string; + } + export interface Params$Resource$Customers$Patch extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Output only. Resource name of the customer. + */ + name?: string; + /** + * Fields to be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalCustomer; + } + + export class Resource$Customers$Devices { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * sasportal.customers.devices.bulk + * @desc Creates a device under a node or customer. Returned devices are unordered. + * @alias sasportal.customers.devices.bulk + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The name of the parent resource. + * @param {().SasPortalBulkCreateDeviceRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + bulk( + params?: Params$Resource$Customers$Devices$Bulk, + options?: MethodOptions + ): GaxiosPromise; + bulk( + params: Params$Resource$Customers$Devices$Bulk, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulk( + params: Params$Resource$Customers$Devices$Bulk, + callback: BodyResponseCallback + ): void; + bulk( + callback: BodyResponseCallback + ): void; + bulk( + paramsOrCallback?: + | Params$Resource$Customers$Devices$Bulk + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customers$Devices$Bulk; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Devices$Bulk; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/devices:bulk').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * sasportal.customers.devices.create + * @desc Creates a device under a node or customer. + * @alias sasportal.customers.devices.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The name of the parent resource. + * @param {().SasPortalDevice} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params?: Params$Resource$Customers$Devices$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Customers$Devices$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Customers$Devices$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Customers$Devices$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customers$Devices$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Devices$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/devices').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sasportal.customers.devices.createSigned + * @desc Creates a signed device under a node or customer. + * @alias sasportal.customers.devices.createSigned + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The name of the parent resource. + * @param {().SasPortalCreateSignedDeviceRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + createSigned( + params?: Params$Resource$Customers$Devices$Createsigned, + options?: MethodOptions + ): GaxiosPromise; + createSigned( + params: Params$Resource$Customers$Devices$Createsigned, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + createSigned( + params: Params$Resource$Customers$Devices$Createsigned, + callback: BodyResponseCallback + ): void; + createSigned(callback: BodyResponseCallback): void; + createSigned( + paramsOrCallback?: + | Params$Resource$Customers$Devices$Createsigned + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customers$Devices$Createsigned; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Devices$Createsigned; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/devices:createSigned').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sasportal.customers.devices.delete + * @desc Deletes a device. + * @alias sasportal.customers.devices.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the device. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Customers$Devices$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Customers$Devices$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Customers$Devices$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Customers$Devices$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customers$Devices$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Devices$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sasportal.customers.devices.get + * @desc Gets details about a device. + * @alias sasportal.customers.devices.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the device. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Customers$Devices$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Customers$Devices$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Customers$Devices$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Customers$Devices$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customers$Devices$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Devices$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sasportal.customers.devices.list + * @desc Lists devices under a node or customer. + * @alias sasportal.customers.devices.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter The filter expression. The filter should have one of the following formats: "sn=123454" or "display_name=MyDevice". sn corresponds to serial_number of the device. The filter is case insensitive. + * @param {integer=} params.pageSize The maximum number of devices to return in the response. + * @param {string=} params.pageToken A pagination token returned from a previous call to ListDevices that indicates where this listing should continue from. + * @param {string} params.parent Required. The name of the parent 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 + */ + list( + params?: Params$Resource$Customers$Devices$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Customers$Devices$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Customers$Devices$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Customers$Devices$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customers$Devices$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Devices$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/devices').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * sasportal.customers.devices.move + * @desc Moves a device under another node or customer. + * @alias sasportal.customers.devices.move + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the device to move. + * @param {().SasPortalMoveDeviceRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + move( + params?: Params$Resource$Customers$Devices$Move, + options?: MethodOptions + ): GaxiosPromise; + move( + params: Params$Resource$Customers$Devices$Move, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + move( + params: Params$Resource$Customers$Devices$Move, + callback: BodyResponseCallback + ): void; + move(callback: BodyResponseCallback): void; + move( + paramsOrCallback?: + | Params$Resource$Customers$Devices$Move + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customers$Devices$Move; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Devices$Move; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}:move').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sasportal.customers.devices.patch + * @desc Updates a device. + * @alias sasportal.customers.devices.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Output only. The resource path name. + * @param {string=} params.updateMask Fields to be updated. + * @param {().SasPortalDevice} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Customers$Devices$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Customers$Devices$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Customers$Devices$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Customers$Devices$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customers$Devices$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Devices$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sasportal.customers.devices.signDevice + * @desc Signs a device. + * @alias sasportal.customers.devices.signDevice + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Output only. The resource path name. + * @param {().SasPortalSignDeviceRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + signDevice( + params?: Params$Resource$Customers$Devices$Signdevice, + options?: MethodOptions + ): GaxiosPromise; + signDevice( + params: Params$Resource$Customers$Devices$Signdevice, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + signDevice( + params: Params$Resource$Customers$Devices$Signdevice, + callback: BodyResponseCallback + ): void; + signDevice(callback: BodyResponseCallback): void; + signDevice( + paramsOrCallback?: + | Params$Resource$Customers$Devices$Signdevice + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customers$Devices$Signdevice; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Devices$Signdevice; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}:signDevice').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sasportal.customers.devices.updateSigned + * @desc Updates a signed device. + * @alias sasportal.customers.devices.updateSigned + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the device to update. + * @param {().SasPortalUpdateSignedDeviceRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + updateSigned( + params?: Params$Resource$Customers$Devices$Updatesigned, + options?: MethodOptions + ): GaxiosPromise; + updateSigned( + params: Params$Resource$Customers$Devices$Updatesigned, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateSigned( + params: Params$Resource$Customers$Devices$Updatesigned, + callback: BodyResponseCallback + ): void; + updateSigned(callback: BodyResponseCallback): void; + updateSigned( + paramsOrCallback?: + | Params$Resource$Customers$Devices$Updatesigned + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customers$Devices$Updatesigned; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Devices$Updatesigned; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}:updateSigned').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Customers$Devices$Bulk + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the parent resource. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalBulkCreateDeviceRequest; + } + export interface Params$Resource$Customers$Devices$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the parent resource. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalDevice; + } + export interface Params$Resource$Customers$Devices$Createsigned + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the parent resource. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalCreateSignedDeviceRequest; + } + export interface Params$Resource$Customers$Devices$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the device. + */ + name?: string; + } + export interface Params$Resource$Customers$Devices$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the device. + */ + name?: string; + } + export interface Params$Resource$Customers$Devices$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The filter expression. The filter should have one of the following formats: "sn=123454" or "display_name=MyDevice". sn corresponds to serial_number of the device. The filter is case insensitive. + */ + filter?: string; + /** + * The maximum number of devices to return in the response. + */ + pageSize?: number; + /** + * A pagination token returned from a previous call to ListDevices that indicates where this listing should continue from. + */ + pageToken?: string; + /** + * Required. The name of the parent resource. + */ + parent?: string; + } + export interface Params$Resource$Customers$Devices$Move + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the device to move. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalMoveDeviceRequest; + } + export interface Params$Resource$Customers$Devices$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Output only. The resource path name. + */ + name?: string; + /** + * Fields to be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalDevice; + } + export interface Params$Resource$Customers$Devices$Signdevice + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Output only. The resource path name. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalSignDeviceRequest; + } + export interface Params$Resource$Customers$Devices$Updatesigned + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the device to update. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalUpdateSignedDeviceRequest; + } + + export class Resource$Customers$Nodes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * sasportal.customers.nodes.create + * @desc Creates a new node. + * @alias sasportal.customers.nodes.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The parent resource name where the node is to be created. + * @param {().SasPortalNode} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params?: Params$Resource$Customers$Nodes$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Customers$Nodes$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Customers$Nodes$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Customers$Nodes$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customers$Nodes$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Nodes$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/nodes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sasportal.customers.nodes.delete + * @desc Deletes a node. + * @alias sasportal.customers.nodes.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the node. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Customers$Nodes$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Customers$Nodes$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Customers$Nodes$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Customers$Nodes$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customers$Nodes$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Nodes$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sasportal.customers.nodes.get + * @desc Returns a requested node. + * @alias sasportal.customers.nodes.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the node. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Customers$Nodes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Customers$Nodes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Customers$Nodes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Customers$Nodes$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customers$Nodes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Nodes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sasportal.customers.nodes.list + * @desc Lists nodes. + * @alias sasportal.customers.nodes.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize The maximum number of nodes to return in the response. + * @param {string=} params.pageToken A pagination token returned from a previous call to ListNodes method that indicates where this listing should continue from. + * @param {string} params.parent Required. The parent resource name, for example, "nodes/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 + */ + list( + params?: Params$Resource$Customers$Nodes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Customers$Nodes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Customers$Nodes$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Customers$Nodes$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customers$Nodes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Nodes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/nodes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sasportal.customers.nodes.move + * @desc Moves a node under another node or customer. + * @alias sasportal.customers.nodes.move + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the node to move. + * @param {().SasPortalMoveNodeRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + move( + params?: Params$Resource$Customers$Nodes$Move, + options?: MethodOptions + ): GaxiosPromise; + move( + params: Params$Resource$Customers$Nodes$Move, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + move( + params: Params$Resource$Customers$Nodes$Move, + callback: BodyResponseCallback + ): void; + move(callback: BodyResponseCallback): void; + move( + paramsOrCallback?: + | Params$Resource$Customers$Nodes$Move + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customers$Nodes$Move; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Nodes$Move; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}:move').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sasportal.customers.nodes.patch + * @desc Updates an existing node. + * @alias sasportal.customers.nodes.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Output only. Resource name. + * @param {string=} params.updateMask Fields to be updated. + * @param {().SasPortalNode} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Customers$Nodes$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Customers$Nodes$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Customers$Nodes$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Customers$Nodes$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customers$Nodes$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Nodes$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Customers$Nodes$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The parent resource name where the node is to be created. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalNode; + } + export interface Params$Resource$Customers$Nodes$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the node. + */ + name?: string; + } + export interface Params$Resource$Customers$Nodes$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the node. + */ + name?: string; + } + export interface Params$Resource$Customers$Nodes$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The maximum number of nodes to return in the response. + */ + pageSize?: number; + /** + * A pagination token returned from a previous call to ListNodes method that indicates where this listing should continue from. + */ + pageToken?: string; + /** + * Required. The parent resource name, for example, "nodes/1". + */ + parent?: string; + } + export interface Params$Resource$Customers$Nodes$Move + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the node to move. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalMoveNodeRequest; + } + export interface Params$Resource$Customers$Nodes$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Output only. Resource name. + */ + name?: string; + /** + * Fields to be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalNode; + } + + export class Resource$Installer { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * sasportal.installer.generateSecret + * @desc Generates a secret to be used with the ValidateInstaller method + * @alias sasportal.installer.generateSecret + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().SasPortalGenerateSecretRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + generateSecret( + params?: Params$Resource$Installer$Generatesecret, + options?: MethodOptions + ): GaxiosPromise; + generateSecret( + params: Params$Resource$Installer$Generatesecret, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateSecret( + params: Params$Resource$Installer$Generatesecret, + callback: BodyResponseCallback + ): void; + generateSecret( + callback: BodyResponseCallback + ): void; + generateSecret( + paramsOrCallback?: + | Params$Resource$Installer$Generatesecret + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Installer$Generatesecret; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Installer$Generatesecret; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/installer:generateSecret').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * sasportal.installer.validate + * @desc Validates the identity of a Certified Professional Installer (CPI). + * @alias sasportal.installer.validate + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().SasPortalValidateInstallerRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + validate( + params?: Params$Resource$Installer$Validate, + options?: MethodOptions + ): GaxiosPromise; + validate( + params: Params$Resource$Installer$Validate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + validate( + params: Params$Resource$Installer$Validate, + callback: BodyResponseCallback + ): void; + validate( + callback: BodyResponseCallback + ): void; + validate( + paramsOrCallback?: + | Params$Resource$Installer$Validate + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Installer$Validate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Installer$Validate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/installer:validate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Installer$Generatesecret + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalGenerateSecretRequest; + } + export interface Params$Resource$Installer$Validate + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalValidateInstallerRequest; + } + + export class Resource$Nodes { + context: APIRequestContext; + devices: Resource$Nodes$Devices; + nodes: Resource$Nodes$Nodes; + constructor(context: APIRequestContext) { + this.context = context; + this.devices = new Resource$Nodes$Devices(this.context); + this.nodes = new Resource$Nodes$Nodes(this.context); + } + } + + export class Resource$Nodes$Devices { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * sasportal.nodes.devices.bulk + * @desc Creates a device under a node or customer. Returned devices are unordered. + * @alias sasportal.nodes.devices.bulk + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The name of the parent resource. + * @param {().SasPortalBulkCreateDeviceRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + bulk( + params?: Params$Resource$Nodes$Devices$Bulk, + options?: MethodOptions + ): GaxiosPromise; + bulk( + params: Params$Resource$Nodes$Devices$Bulk, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulk( + params: Params$Resource$Nodes$Devices$Bulk, + callback: BodyResponseCallback + ): void; + bulk( + callback: BodyResponseCallback + ): void; + bulk( + paramsOrCallback?: + | Params$Resource$Nodes$Devices$Bulk + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodes$Devices$Bulk; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodes$Devices$Bulk; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/devices:bulk').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * sasportal.nodes.devices.create + * @desc Creates a device under a node or customer. + * @alias sasportal.nodes.devices.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The name of the parent resource. + * @param {().SasPortalDevice} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params?: Params$Resource$Nodes$Devices$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Nodes$Devices$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Nodes$Devices$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Nodes$Devices$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodes$Devices$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodes$Devices$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/devices').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sasportal.nodes.devices.createSigned + * @desc Creates a signed device under a node or customer. + * @alias sasportal.nodes.devices.createSigned + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The name of the parent resource. + * @param {().SasPortalCreateSignedDeviceRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + createSigned( + params?: Params$Resource$Nodes$Devices$Createsigned, + options?: MethodOptions + ): GaxiosPromise; + createSigned( + params: Params$Resource$Nodes$Devices$Createsigned, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + createSigned( + params: Params$Resource$Nodes$Devices$Createsigned, + callback: BodyResponseCallback + ): void; + createSigned(callback: BodyResponseCallback): void; + createSigned( + paramsOrCallback?: + | Params$Resource$Nodes$Devices$Createsigned + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodes$Devices$Createsigned; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodes$Devices$Createsigned; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/devices:createSigned').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sasportal.nodes.devices.delete + * @desc Deletes a device. + * @alias sasportal.nodes.devices.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the device. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Nodes$Devices$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Nodes$Devices$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Nodes$Devices$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Nodes$Devices$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodes$Devices$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodes$Devices$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sasportal.nodes.devices.get + * @desc Gets details about a device. + * @alias sasportal.nodes.devices.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the device. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Nodes$Devices$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Nodes$Devices$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Nodes$Devices$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Nodes$Devices$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodes$Devices$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodes$Devices$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sasportal.nodes.devices.list + * @desc Lists devices under a node or customer. + * @alias sasportal.nodes.devices.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter The filter expression. The filter should have one of the following formats: "sn=123454" or "display_name=MyDevice". sn corresponds to serial_number of the device. The filter is case insensitive. + * @param {integer=} params.pageSize The maximum number of devices to return in the response. + * @param {string=} params.pageToken A pagination token returned from a previous call to ListDevices that indicates where this listing should continue from. + * @param {string} params.parent Required. The name of the parent 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 + */ + list( + params?: Params$Resource$Nodes$Devices$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Nodes$Devices$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Nodes$Devices$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Nodes$Devices$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodes$Devices$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodes$Devices$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/devices').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * sasportal.nodes.devices.move + * @desc Moves a device under another node or customer. + * @alias sasportal.nodes.devices.move + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the device to move. + * @param {().SasPortalMoveDeviceRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + move( + params?: Params$Resource$Nodes$Devices$Move, + options?: MethodOptions + ): GaxiosPromise; + move( + params: Params$Resource$Nodes$Devices$Move, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + move( + params: Params$Resource$Nodes$Devices$Move, + callback: BodyResponseCallback + ): void; + move(callback: BodyResponseCallback): void; + move( + paramsOrCallback?: + | Params$Resource$Nodes$Devices$Move + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodes$Devices$Move; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodes$Devices$Move; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}:move').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sasportal.nodes.devices.patch + * @desc Updates a device. + * @alias sasportal.nodes.devices.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Output only. The resource path name. + * @param {string=} params.updateMask Fields to be updated. + * @param {().SasPortalDevice} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Nodes$Devices$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Nodes$Devices$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Nodes$Devices$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Nodes$Devices$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodes$Devices$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodes$Devices$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sasportal.nodes.devices.signDevice + * @desc Signs a device. + * @alias sasportal.nodes.devices.signDevice + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Output only. The resource path name. + * @param {().SasPortalSignDeviceRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + signDevice( + params?: Params$Resource$Nodes$Devices$Signdevice, + options?: MethodOptions + ): GaxiosPromise; + signDevice( + params: Params$Resource$Nodes$Devices$Signdevice, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + signDevice( + params: Params$Resource$Nodes$Devices$Signdevice, + callback: BodyResponseCallback + ): void; + signDevice(callback: BodyResponseCallback): void; + signDevice( + paramsOrCallback?: + | Params$Resource$Nodes$Devices$Signdevice + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodes$Devices$Signdevice; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodes$Devices$Signdevice; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}:signDevice').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sasportal.nodes.devices.updateSigned + * @desc Updates a signed device. + * @alias sasportal.nodes.devices.updateSigned + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the device to update. + * @param {().SasPortalUpdateSignedDeviceRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + updateSigned( + params?: Params$Resource$Nodes$Devices$Updatesigned, + options?: MethodOptions + ): GaxiosPromise; + updateSigned( + params: Params$Resource$Nodes$Devices$Updatesigned, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateSigned( + params: Params$Resource$Nodes$Devices$Updatesigned, + callback: BodyResponseCallback + ): void; + updateSigned(callback: BodyResponseCallback): void; + updateSigned( + paramsOrCallback?: + | Params$Resource$Nodes$Devices$Updatesigned + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodes$Devices$Updatesigned; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodes$Devices$Updatesigned; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}:updateSigned').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Nodes$Devices$Bulk + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the parent resource. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalBulkCreateDeviceRequest; + } + export interface Params$Resource$Nodes$Devices$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the parent resource. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalDevice; + } + export interface Params$Resource$Nodes$Devices$Createsigned + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the parent resource. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalCreateSignedDeviceRequest; + } + export interface Params$Resource$Nodes$Devices$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the device. + */ + name?: string; + } + export interface Params$Resource$Nodes$Devices$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the device. + */ + name?: string; + } + export interface Params$Resource$Nodes$Devices$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The filter expression. The filter should have one of the following formats: "sn=123454" or "display_name=MyDevice". sn corresponds to serial_number of the device. The filter is case insensitive. + */ + filter?: string; + /** + * The maximum number of devices to return in the response. + */ + pageSize?: number; + /** + * A pagination token returned from a previous call to ListDevices that indicates where this listing should continue from. + */ + pageToken?: string; + /** + * Required. The name of the parent resource. + */ + parent?: string; + } + export interface Params$Resource$Nodes$Devices$Move + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the device to move. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalMoveDeviceRequest; + } + export interface Params$Resource$Nodes$Devices$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Output only. The resource path name. + */ + name?: string; + /** + * Fields to be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalDevice; + } + export interface Params$Resource$Nodes$Devices$Signdevice + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Output only. The resource path name. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalSignDeviceRequest; + } + export interface Params$Resource$Nodes$Devices$Updatesigned + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the device to update. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalUpdateSignedDeviceRequest; + } + + export class Resource$Nodes$Nodes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * sasportal.nodes.nodes.create + * @desc Creates a new node. + * @alias sasportal.nodes.nodes.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The parent resource name where the node is to be created. + * @param {().SasPortalNode} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params?: Params$Resource$Nodes$Nodes$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Nodes$Nodes$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Nodes$Nodes$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Nodes$Nodes$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodes$Nodes$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodes$Nodes$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/nodes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sasportal.nodes.nodes.delete + * @desc Deletes a node. + * @alias sasportal.nodes.nodes.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the node. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Nodes$Nodes$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Nodes$Nodes$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Nodes$Nodes$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Nodes$Nodes$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodes$Nodes$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodes$Nodes$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sasportal.nodes.nodes.get + * @desc Returns a requested node. + * @alias sasportal.nodes.nodes.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the node. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Nodes$Nodes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Nodes$Nodes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Nodes$Nodes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Nodes$Nodes$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Nodes$Nodes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodes$Nodes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sasportal.nodes.nodes.list + * @desc Lists nodes. + * @alias sasportal.nodes.nodes.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize The maximum number of nodes to return in the response. + * @param {string=} params.pageToken A pagination token returned from a previous call to ListNodes method that indicates where this listing should continue from. + * @param {string} params.parent Required. The parent resource name, for example, "nodes/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 + */ + list( + params?: Params$Resource$Nodes$Nodes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Nodes$Nodes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Nodes$Nodes$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Nodes$Nodes$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Nodes$Nodes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodes$Nodes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/nodes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sasportal.nodes.nodes.move + * @desc Moves a node under another node or customer. + * @alias sasportal.nodes.nodes.move + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the node to move. + * @param {().SasPortalMoveNodeRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + move( + params?: Params$Resource$Nodes$Nodes$Move, + options?: MethodOptions + ): GaxiosPromise; + move( + params: Params$Resource$Nodes$Nodes$Move, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + move( + params: Params$Resource$Nodes$Nodes$Move, + callback: BodyResponseCallback + ): void; + move(callback: BodyResponseCallback): void; + move( + paramsOrCallback?: + | Params$Resource$Nodes$Nodes$Move + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Nodes$Nodes$Move; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodes$Nodes$Move; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}:move').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sasportal.nodes.nodes.patch + * @desc Updates an existing node. + * @alias sasportal.nodes.nodes.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Output only. Resource name. + * @param {string=} params.updateMask Fields to be updated. + * @param {().SasPortalNode} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Nodes$Nodes$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Nodes$Nodes$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Nodes$Nodes$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Nodes$Nodes$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodes$Nodes$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodes$Nodes$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Nodes$Nodes$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The parent resource name where the node is to be created. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalNode; + } + export interface Params$Resource$Nodes$Nodes$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the node. + */ + name?: string; + } + export interface Params$Resource$Nodes$Nodes$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the node. + */ + name?: string; + } + export interface Params$Resource$Nodes$Nodes$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The maximum number of nodes to return in the response. + */ + pageSize?: number; + /** + * A pagination token returned from a previous call to ListNodes method that indicates where this listing should continue from. + */ + pageToken?: string; + /** + * Required. The parent resource name, for example, "nodes/1". + */ + parent?: string; + } + export interface Params$Resource$Nodes$Nodes$Move extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the node to move. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalMoveNodeRequest; + } + export interface Params$Resource$Nodes$Nodes$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Output only. Resource name. + */ + name?: string; + /** + * Fields to be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalNode; + } + + export class Resource$Policies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * sasportal.policies.get + * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * @alias sasportal.policies.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().SasPortalGetPolicyRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Policies$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Policies$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Policies$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Policies$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Policies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Policies$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/policies:get').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sasportal.policies.set + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @alias sasportal.policies.set + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().SasPortalSetPolicyRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + set( + params?: Params$Resource$Policies$Set, + options?: MethodOptions + ): GaxiosPromise; + set( + params: Params$Resource$Policies$Set, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + set( + params: Params$Resource$Policies$Set, + callback: BodyResponseCallback + ): void; + set(callback: BodyResponseCallback): void; + set( + paramsOrCallback?: + | Params$Resource$Policies$Set + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Policies$Set; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Policies$Set; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/policies:set').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sasportal.policies.test + * @desc Returns permissions that a caller has on the specified resource. + * @alias sasportal.policies.test + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().SasPortalTestPermissionsRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + test( + params?: Params$Resource$Policies$Test, + options?: MethodOptions + ): GaxiosPromise; + test( + params: Params$Resource$Policies$Test, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + test( + params: Params$Resource$Policies$Test, + callback: BodyResponseCallback + ): void; + test( + callback: BodyResponseCallback + ): void; + test( + paramsOrCallback?: + | Params$Resource$Policies$Test + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Policies$Test; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Policies$Test; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sasportal.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/policies:test').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Policies$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalGetPolicyRequest; + } + export interface Params$Resource$Policies$Set extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalSetPolicyRequest; + } + export interface Params$Resource$Policies$Test extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Request body metadata + */ + requestBody?: Schema$SasPortalTestPermissionsRequest; + } +} diff --git a/src/apis/surveys/webpack.config.js b/src/apis/sasportal/webpack.config.js similarity index 96% rename from src/apis/surveys/webpack.config.js rename to src/apis/sasportal/webpack.config.js index 3d459b61e9e..d0c503a117a 100644 --- a/src/apis/surveys/webpack.config.js +++ b/src/apis/sasportal/webpack.config.js @@ -22,8 +22,8 @@ module.exports = { extensions: ['.ts', '.js', '.json'], }, output: { - library: 'Surveys', - filename: 'surveys.min.js', + library: 'Sasportal', + filename: 'sasportal.min.js', path: path.resolve(__dirname, 'dist'), }, node: { diff --git a/src/apis/searchconsole/v1.ts b/src/apis/searchconsole/v1.ts deleted file mode 100644 index 3a435401fe0..00000000000 --- a/src/apis/searchconsole/v1.ts +++ /dev/null @@ -1,323 +0,0 @@ -// Copyright 2019 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -import { - OAuth2Client, - JWT, - Compute, - UserRefreshClient, -} from 'google-auth-library'; -import { - GoogleConfigurable, - createAPIRequest, - MethodOptions, - GlobalOptions, - BodyResponseCallback, - APIRequestContext, -} from 'googleapis-common'; -import {GaxiosPromise} from 'gaxios'; - -// tslint:disable: no-any -// tslint:disable: class-name -// tslint:disable: variable-name -// tslint:disable: jsdoc-format -// tslint:disable: no-namespace - -export namespace searchconsole_v1 { - export interface Options extends GlobalOptions { - version: 'v1'; - } - - interface StandardParameters { - /** - * V1 error format. - */ - '$.xgafv'?: string; - /** - * OAuth access token. - */ - access_token?: string; - /** - * Data format for response. - */ - alt?: string; - /** - * JSONP - */ - callback?: string; - /** - * Selector specifying which fields to include in a partial response. - */ - fields?: string; - /** - * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - */ - key?: string; - /** - * OAuth 2.0 token for the current user. - */ - oauth_token?: string; - /** - * Returns response with indentations and line breaks. - */ - prettyPrint?: boolean; - /** - * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - */ - quotaUser?: string; - /** - * Legacy upload protocol for media (e.g. "media", "multipart"). - */ - uploadType?: string; - /** - * Upload protocol for media (e.g. "raw", "multipart"). - */ - upload_protocol?: string; - } - - /** - * Google Search Console URL Testing Tools API - * - * Provides tools for running validation tests against single URLs - * - * @example - * const {google} = require('googleapis'); - * const searchconsole = google.searchconsole('v1'); - * - * @namespace searchconsole - * @type {Function} - * @version v1 - * @variation v1 - * @param {object=} options Options for Searchconsole - */ - export class Searchconsole { - context: APIRequestContext; - urlTestingTools: Resource$Urltestingtools; - - constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = { - _options: options || {}, - google, - }; - - this.urlTestingTools = new Resource$Urltestingtools(this.context); - } - } - - /** - * Blocked resource. - */ - export interface Schema$BlockedResource { - /** - * URL of the blocked resource. - */ - url?: string | null; - } - /** - * Describe image data. - */ - export interface Schema$Image { - /** - * Image data in format determined by the mime type. Currently, the format will always be "image/png", but this might change in the future. - */ - data?: string | null; - /** - * The mime-type of the image data. - */ - mimeType?: string | null; - } - /** - * Mobile-friendly issue. - */ - export interface Schema$MobileFriendlyIssue { - /** - * Rule violated. - */ - rule?: string | null; - } - /** - * Information about a resource with issue. - */ - export interface Schema$ResourceIssue { - /** - * Describes a blocked resource issue. - */ - blockedResource?: Schema$BlockedResource; - } - /** - * Mobile-friendly test request. - */ - export interface Schema$RunMobileFriendlyTestRequest { - /** - * Whether or not screenshot is requested. Default is false. - */ - requestScreenshot?: boolean | null; - /** - * URL for inspection. - */ - url?: string | null; - } - /** - * Mobile-friendly test response, including mobile-friendly issues and resource issues. - */ - export interface Schema$RunMobileFriendlyTestResponse { - /** - * Test verdict, whether the page is mobile friendly or not. - */ - mobileFriendliness?: string | null; - /** - * List of mobile-usability issues. - */ - mobileFriendlyIssues?: Schema$MobileFriendlyIssue[]; - /** - * Information about embedded resources issues. - */ - resourceIssues?: Schema$ResourceIssue[]; - /** - * Screenshot of the requested URL. - */ - screenshot?: Schema$Image; - /** - * Final state of the test, can be either complete or an error. - */ - testStatus?: Schema$TestStatus; - } - /** - * Final state of the test, including error details if necessary. - */ - export interface Schema$TestStatus { - /** - * Error details if applicable. - */ - details?: string | null; - /** - * Status of the test. - */ - status?: string | null; - } - - export class Resource$Urltestingtools { - context: APIRequestContext; - mobileFriendlyTest: Resource$Urltestingtools$Mobilefriendlytest; - constructor(context: APIRequestContext) { - this.context = context; - this.mobileFriendlyTest = new Resource$Urltestingtools$Mobilefriendlytest( - this.context - ); - } - } - - export class Resource$Urltestingtools$Mobilefriendlytest { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * searchconsole.urlTestingTools.mobileFriendlyTest.run - * @desc Runs Mobile-Friendly Test for a given URL. - * @alias searchconsole.urlTestingTools.mobileFriendlyTest.run - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {().RunMobileFriendlyTestRequest} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - run( - params?: Params$Resource$Urltestingtools$Mobilefriendlytest$Run, - options?: MethodOptions - ): GaxiosPromise; - run( - params: Params$Resource$Urltestingtools$Mobilefriendlytest$Run, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - run( - params: Params$Resource$Urltestingtools$Mobilefriendlytest$Run, - callback: BodyResponseCallback - ): void; - run( - callback: BodyResponseCallback - ): void; - run( - paramsOrCallback?: - | Params$Resource$Urltestingtools$Mobilefriendlytest$Run - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Urltestingtools$Mobilefriendlytest$Run; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Urltestingtools$Mobilefriendlytest$Run; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://searchconsole.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1/urlTestingTools/mobileFriendlyTest:run' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Urltestingtools$Mobilefriendlytest$Run - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Request body metadata - */ - requestBody?: Schema$RunMobileFriendlyTestRequest; - } -} diff --git a/src/apis/searchconsole/README.md b/src/apis/secretmanager/README.md similarity index 83% rename from src/apis/searchconsole/README.md rename to src/apis/secretmanager/README.md index 5b106abc8b1..004c8f02f29 100644 --- a/src/apis/searchconsole/README.md +++ b/src/apis/secretmanager/README.md @@ -1,8 +1,8 @@ Google Inc. logo -# searchconsole +# secretmanager -> Provides tools for running validation tests against single URLs +> Stores, manages, and secures access to application secrets. ## Installation @@ -19,17 +19,17 @@ This library can be used in a browser. To prepare a single file bundle, clone th [repository](https://github.com/googleapis/google-api-nodejs-client) and run ```sh -$ cd src/apis/searchconsole +$ cd src/apis/secretmanager $ npm install $ npm run webpack ``` -The generated bundle will be written to `dist/searchconsole.min.js`. Use it from your HTML file: +The generated bundle will be written to `dist/secretmanager.min.js`. Use it from your HTML file: ```html - + ``` diff --git a/src/apis/searchconsole/index.ts b/src/apis/secretmanager/index.ts similarity index 61% rename from src/apis/searchconsole/index.ts rename to src/apis/secretmanager/index.ts index 99cb436c6cf..bc3f003e9b1 100644 --- a/src/apis/searchconsole/index.ts +++ b/src/apis/secretmanager/index.ts @@ -14,21 +14,23 @@ /*! THIS FILE IS AUTO-GENERATED */ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; -import {searchconsole_v1} from './v1'; +import {secretmanager_v1beta1} from './v1beta1'; export const VERSIONS = { - v1: searchconsole_v1.Searchconsole, + v1beta1: secretmanager_v1beta1.Secretmanager, }; -export function searchconsole(version: 'v1'): searchconsole_v1.Searchconsole; -export function searchconsole( - options: searchconsole_v1.Options -): searchconsole_v1.Searchconsole; -export function searchconsole( +export function secretmanager( + version: 'v1beta1' +): secretmanager_v1beta1.Secretmanager; +export function secretmanager( + options: secretmanager_v1beta1.Options +): secretmanager_v1beta1.Secretmanager; +export function secretmanager( this: GoogleConfigurable, - versionOrOptions: 'v1' | searchconsole_v1.Options + versionOrOptions: 'v1beta1' | secretmanager_v1beta1.Options ) { - return getAPI('searchconsole', versionOrOptions, VERSIONS, this); + return getAPI('secretmanager', versionOrOptions, VERSIONS, this); } const auth = new AuthPlus(); diff --git a/src/apis/searchconsole/package.json b/src/apis/secretmanager/package.json similarity index 93% rename from src/apis/searchconsole/package.json rename to src/apis/secretmanager/package.json index 7002426fa46..0d17337fdb4 100644 --- a/src/apis/searchconsole/package.json +++ b/src/apis/secretmanager/package.json @@ -1,7 +1,7 @@ { - "name": "@google/searchconsole", + "name": "@google/secretmanager", "version": "0.1.0", - "description": "searchconsole", + "description": "secretmanager", "main": "build/index.js", "types": "build/index.d.ts", "keywords": [ diff --git a/src/apis/surveys/tsconfig.json b/src/apis/secretmanager/tsconfig.json similarity index 100% rename from src/apis/surveys/tsconfig.json rename to src/apis/secretmanager/tsconfig.json diff --git a/src/apis/secretmanager/v1beta1.ts b/src/apis/secretmanager/v1beta1.ts new file mode 100644 index 00000000000..74f66e5fdfa --- /dev/null +++ b/src/apis/secretmanager/v1beta1.ts @@ -0,0 +1,2038 @@ +// Copyright 2019 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, +} from 'google-auth-library'; +import { + GoogleConfigurable, + createAPIRequest, + MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace secretmanager_v1beta1 { + export interface Options extends GlobalOptions { + version: 'v1beta1'; + } + + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * Secret Manager API + * + * Stores, manages, and secures access to application secrets. + * + * @example + * const {google} = require('googleapis'); + * const secretmanager = google.secretmanager('v1beta1'); + * + * @namespace secretmanager + * @type {Function} + * @version v1beta1 + * @variation v1beta1 + * @param {object=} options Options for Secretmanager + */ + export class Secretmanager { + context: APIRequestContext; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.projects = new Resource$Projects(this.context); + } + } + + /** + * Response message for SecretManagerService.AccessSecretVersion. + */ + export interface Schema$AccessSecretVersionResponse { + /** + * The resource name of the SecretVersion in the format `projects/x/secrets/x/versions/x. + */ + name?: string | null; + /** + * Secret payload + */ + payload?: Schema$SecretPayload; + } + /** + * Request message for SecretManagerService.AddSecretVersion. + */ + export interface Schema$AddSecretVersionRequest { + /** + * Required. The secret payload of the SecretVersion. + */ + payload?: Schema$SecretPayload; + } + /** + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + */ + export interface Schema$AuditConfig { + /** + * The configuration for logging of each type of permission. + */ + auditLogConfigs?: Schema$AuditLogConfig[]; + /** + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. + */ + service?: string | null; + } + /** + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. + */ + export interface Schema$AuditLogConfig { + /** + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. + */ + exemptedMembers?: string[] | null; + /** + * The log type that this config enables. + */ + logType?: string | null; + } + /** + * A replication policy that replicates the Secret payload without any restrictions. + */ + export interface Schema$Automatic {} + /** + * Associates `members` with a `role`. + */ + export interface Schema$Binding { + /** + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. + */ + condition?: Schema$Expr; + /** + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + */ + members?: string[] | null; + /** + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + */ + role?: string | null; + } + /** + * Request message for SecretManagerService.DestroySecretVersion. + */ + export interface Schema$DestroySecretVersionRequest {} + /** + * Request message for SecretManagerService.DisableSecretVersion. + */ + export interface Schema$DisableSecretVersionRequest {} + /** + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + */ + export interface Schema$Empty {} + /** + * Request message for SecretManagerService.EnableSecretVersion. + */ + export interface Schema$EnableSecretVersionRequest {} + /** + * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + */ + export interface Schema$Expr { + /** + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + */ + description?: string | null; + /** + * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + */ + expression?: string | null; + /** + * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + */ + location?: string | null; + /** + * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + */ + title?: string | null; + } + /** + * The response message for Locations.ListLocations. + */ + export interface Schema$ListLocationsResponse { + /** + * A list of locations that matches the specified filter in the request. + */ + locations?: Schema$Location[]; + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + } + /** + * Response message for SecretManagerService.ListSecrets. + */ + export interface Schema$ListSecretsResponse { + /** + * A token to retrieve the next page of results. Pass this value in ListSecretsRequest.page_token to retrieve the next page. + */ + nextPageToken?: string | null; + /** + * The list of Secrets sorted in reverse by create_time (newest first). + */ + secrets?: Schema$Secret[]; + /** + * The total number of Secrets. + */ + totalSize?: number | null; + } + /** + * Response message for SecretManagerService.ListSecretVersions. + */ + export interface Schema$ListSecretVersionsResponse { + /** + * A token to retrieve the next page of results. Pass this value in ListSecretVersionsRequest.page_token to retrieve the next page. + */ + nextPageToken?: string | null; + /** + * The total number of SecretVersions. + */ + totalSize?: number | null; + /** + * The list of SecretVersions sorted in reverse by create_time (newest first). + */ + versions?: Schema$SecretVersion[]; + } + /** + * A resource that represents Google Cloud Platform location. + */ + export interface Schema$Location { + /** + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". + */ + displayName?: string | null; + /** + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} + */ + labels?: {[key: string]: string} | null; + /** + * The canonical id for this location. For example: `"us-east1"`. + */ + locationId?: string | null; + /** + * Service-specific metadata. For example the available capacity at the given location. + */ + metadata?: {[key: string]: any} | null; + /** + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` + */ + name?: string | null; + } + /** + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + */ + export interface Schema$Policy { + /** + * Specifies cloud audit logging configuration for this policy. + */ + auditConfigs?: Schema$AuditConfig[]; + /** + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + */ + bindings?: Schema$Binding[]; + /** + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. + */ + etag?: string | null; + /** + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. + */ + version?: number | null; + } + /** + * Represents a Replica for this Secret. + */ + export interface Schema$Replica { + /** + * The canonical IDs of the location to replicate data. For example: `"us-east1"`. + */ + location?: string | null; + } + /** + * A policy that defines the replication configuration of data. + */ + export interface Schema$Replication { + /** + * The Secret will automatically be replicated without any restrictions. + */ + automatic?: Schema$Automatic; + /** + * The Secret will only be replicated into the locations specified. + */ + userManaged?: Schema$UserManaged; + } + /** + * A Secret is a logical secret whose value and versions can be accessed. A Secret is made up of zero or more SecretVersions that represent the secret data. + */ + export interface Schema$Secret { + /** + * Output only. The time at which the Secret was created. + */ + createTime?: string | null; + /** + * The labels assigned to this Secret. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: `\p{Ll}\p{Lo}{0,62}` Label values must be between 0 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}` No more than 64 labels can be assigned to a given resource. + */ + labels?: {[key: string]: string} | null; + /** + * Output only. The resource name of the Secret in the format `projects/x/secrets/x. + */ + name?: string | null; + /** + * Required. Immutable. The replication policy of the secret data attached to the Secret. The replication policy cannot be changed after the Secret has been created. + */ + replication?: Schema$Replication; + } + /** + * A secret payload resource in the Secret Manager API. This contains the sensitive secret data that is associated with a SecretVersion. + */ + export interface Schema$SecretPayload { + /** + * The secret data. Must be no larger than 64KiB. + */ + data?: string | null; + } + /** + * A secret version resource in the Secret Manager API. + */ + export interface Schema$SecretVersion { + /** + * Output only. The time at which the SecretVersion was created. + */ + createTime?: string | null; + /** + * Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED. + */ + destroyTime?: string | null; + /** + * Output only. The resource name of the SecretVersion in the format `projects/x/secrets/x/versions/x. SecretVersion IDs in a Secret start at 1 and are incremented for each subsequent version of the secret. + */ + name?: string | null; + /** + * Output only. The current state of the SecretVersion. + */ + state?: string | null; + } + /** + * Request message for `SetIamPolicy` method. + */ + export interface Schema$SetIamPolicyRequest { + /** + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. + */ + policy?: Schema$Policy; + /** + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM. + */ + updateMask?: string | null; + } + /** + * Request message for `TestIamPermissions` method. + */ + export interface Schema$TestIamPermissionsRequest { + /** + * The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + */ + permissions?: string[] | null; + } + /** + * Response message for `TestIamPermissions` method. + */ + export interface Schema$TestIamPermissionsResponse { + /** + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. + */ + permissions?: string[] | null; + } + /** + * A replication policy that replicates the Secret payload into the locations specified in Secret.replication.user_managed.replicas + */ + export interface Schema$UserManaged { + /** + * Required. The list of Replicas for this Secret. Cannot be empty. + */ + replicas?: Schema$Replica[]; + } + + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + secrets: Resource$Projects$Secrets; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + this.secrets = new Resource$Projects$Secrets(this.context); + } + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * secretmanager.projects.locations.get + * @desc Gets information about a location. + * @alias secretmanager.projects.locations.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Resource name for the location. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Projects$Locations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * secretmanager.projects.locations.list + * @desc Lists information about the supported locations for this service. + * @alias secretmanager.projects.locations.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter The standard list filter. + * @param {string} params.name The resource that owns the locations collection, if applicable. + * @param {integer=} params.pageSize The standard list page size. + * @param {string=} params.pageToken The standard list page token. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$Locations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}/locations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Resource name for the location. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The standard list filter. + */ + filter?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Secrets { + context: APIRequestContext; + versions: Resource$Projects$Secrets$Versions; + constructor(context: APIRequestContext) { + this.context = context; + this.versions = new Resource$Projects$Secrets$Versions(this.context); + } + + /** + * secretmanager.projects.secrets.addVersion + * @desc Creates a new SecretVersion containing secret data and attaches it to an existing Secret. + * @alias secretmanager.projects.secrets.addVersion + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The resource name of the Secret to associate with the SecretVersion in the format `projects/x/secrets/x`. + * @param {().AddSecretVersionRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + addVersion( + params?: Params$Resource$Projects$Secrets$Addversion, + options?: MethodOptions + ): GaxiosPromise; + addVersion( + params: Params$Resource$Projects$Secrets$Addversion, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addVersion( + params: Params$Resource$Projects$Secrets$Addversion, + callback: BodyResponseCallback + ): void; + addVersion(callback: BodyResponseCallback): void; + addVersion( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Addversion + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Addversion; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Addversion; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}:addVersion').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * secretmanager.projects.secrets.create + * @desc Creates a new Secret containing no SecretVersions. + * @alias secretmanager.projects.secrets.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The resource name of the project to associate with the Secret, in the format `projects/x`. + * @param {string=} params.secretId Required. This must be unique within the project. + * @param {().Secret} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params?: Params$Resource$Projects$Secrets$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Secrets$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Secrets$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/secrets').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * secretmanager.projects.secrets.delete + * @desc Deletes a Secret. + * @alias secretmanager.projects.secrets.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name of the Secret to delete in the format `projects/x/secrets/x`. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Projects$Secrets$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Secrets$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Secrets$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * secretmanager.projects.secrets.get + * @desc Gets metadata for a given Secret. + * @alias secretmanager.projects.secrets.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name of the Secret, in the format `projects/x/secrets/x`. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Projects$Secrets$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Secrets$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Secrets$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * secretmanager.projects.secrets.getIamPolicy + * @desc Gets the access control policy for a secret. Returns empty policy if the secret exists and does not have a policy set. + * @alias secretmanager.projects.secrets.getIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIamPolicy( + params?: Params$Resource$Projects$Secrets$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Secrets$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Secrets$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * secretmanager.projects.secrets.list + * @desc Lists Secrets. + * @alias secretmanager.projects.secrets.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize Optional. The maximum number of results to be returned in a single page. If set to 0, the server decides the number of results to return. If the number is greater than 25000, it is capped at 25000. + * @param {string=} params.pageToken Optional. Pagination token, returned earlier via ListSecretsResponse.next_page_token. + * @param {string} params.parent Required. The resource name of the project associated with the Secrets, in the format `projects/x`. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$Secrets$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Secrets$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Secrets$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/secrets').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * secretmanager.projects.secrets.patch + * @desc Updates metadata of an existing Secret. + * @alias secretmanager.projects.secrets.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Output only. The resource name of the Secret in the format `projects/x/secrets/x`. + * @param {string=} params.updateMask Required. Specifies the fields to be updated. + * @param {().Secret} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Projects$Secrets$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Secrets$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Secrets$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Patch + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * secretmanager.projects.secrets.setIamPolicy + * @desc Sets the access control policy on the specified secret. Replaces any existing policy. Permissions on SecretVersions are enforced according to the policy set on the associated Secret. + * @alias secretmanager.projects.secrets.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. + * @param {().SetIamPolicyRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setIamPolicy( + params?: Params$Resource$Projects$Secrets$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Secrets$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Secrets$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * secretmanager.projects.secrets.testIamPermissions + * @desc Returns permissions that a caller has for the specified secret. If the secret does not exist, this call returns an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @alias secretmanager.projects.secrets.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. + * @param {().TestIamPermissionsRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Projects$Secrets$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Secrets$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Secrets$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Secrets$Addversion + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the Secret to associate with the SecretVersion in the format `projects/x/secrets/x`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AddSecretVersionRequest; + } + export interface Params$Resource$Projects$Secrets$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the project to associate with the Secret, in the format `projects/x`. + */ + parent?: string; + /** + * Required. This must be unique within the project. + */ + secretId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Secret; + } + export interface Params$Resource$Projects$Secrets$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the Secret to delete in the format `projects/x/secrets/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Secrets$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the Secret, in the format `projects/x/secrets/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Secrets$Getiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Secrets$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional. The maximum number of results to be returned in a single page. If set to 0, the server decides the number of results to return. If the number is greater than 25000, it is capped at 25000. + */ + pageSize?: number; + /** + * Optional. Pagination token, returned earlier via ListSecretsResponse.next_page_token. + */ + pageToken?: string; + /** + * Required. The resource name of the project associated with the Secrets, in the format `projects/x`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Secrets$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Output only. The resource name of the Secret in the format `projects/x/secrets/x`. + */ + name?: string; + /** + * Required. Specifies the fields to be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Secret; + } + export interface Params$Resource$Projects$Secrets$Setiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Secrets$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + + export class Resource$Projects$Secrets$Versions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * secretmanager.projects.secrets.versions.access + * @desc Accesses a SecretVersion. This call returns the secret data. `projects/x/secrets/x/versions/latest` is an alias to the `latest` SecretVersion. + * @alias secretmanager.projects.secrets.versions.access + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name of the SecretVersion in the format `projects/x/secrets/x/versions/x`. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + access( + params?: Params$Resource$Projects$Secrets$Versions$Access, + options?: MethodOptions + ): GaxiosPromise; + access( + params: Params$Resource$Projects$Secrets$Versions$Access, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + access( + params: Params$Resource$Projects$Secrets$Versions$Access, + callback: BodyResponseCallback + ): void; + access( + callback: BodyResponseCallback + ): void; + access( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Versions$Access + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Versions$Access; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Versions$Access; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:access').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * secretmanager.projects.secrets.versions.destroy + * @desc Destroys a SecretVersion. Sets the state of the SecretVersion to DESTROYED and irrevocably destroys the secret data. + * @alias secretmanager.projects.secrets.versions.destroy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name of the SecretVersion to destroy in the format `projects/x/secrets/x/versions/x`. + * @param {().DestroySecretVersionRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + destroy( + params?: Params$Resource$Projects$Secrets$Versions$Destroy, + options?: MethodOptions + ): GaxiosPromise; + destroy( + params: Params$Resource$Projects$Secrets$Versions$Destroy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + destroy( + params: Params$Resource$Projects$Secrets$Versions$Destroy, + callback: BodyResponseCallback + ): void; + destroy(callback: BodyResponseCallback): void; + destroy( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Versions$Destroy + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Versions$Destroy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Versions$Destroy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:destroy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * secretmanager.projects.secrets.versions.disable + * @desc Disables a SecretVersion. Sets the state of the SecretVersion to DISABLED. + * @alias secretmanager.projects.secrets.versions.disable + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name of the SecretVersion to disable in the format `projects/x/secrets/x/versions/x`. + * @param {().DisableSecretVersionRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + disable( + params?: Params$Resource$Projects$Secrets$Versions$Disable, + options?: MethodOptions + ): GaxiosPromise; + disable( + params: Params$Resource$Projects$Secrets$Versions$Disable, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + disable( + params: Params$Resource$Projects$Secrets$Versions$Disable, + callback: BodyResponseCallback + ): void; + disable(callback: BodyResponseCallback): void; + disable( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Versions$Disable + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Versions$Disable; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Versions$Disable; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:disable').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * secretmanager.projects.secrets.versions.enable + * @desc Enables a SecretVersion. Sets the state of the SecretVersion to ENABLED. + * @alias secretmanager.projects.secrets.versions.enable + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name of the SecretVersion to enable in the format `projects/x/secrets/x/versions/x`. + * @param {().EnableSecretVersionRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + enable( + params?: Params$Resource$Projects$Secrets$Versions$Enable, + options?: MethodOptions + ): GaxiosPromise; + enable( + params: Params$Resource$Projects$Secrets$Versions$Enable, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + enable( + params: Params$Resource$Projects$Secrets$Versions$Enable, + callback: BodyResponseCallback + ): void; + enable(callback: BodyResponseCallback): void; + enable( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Versions$Enable + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Versions$Enable; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Versions$Enable; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:enable').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * secretmanager.projects.secrets.versions.get + * @desc Gets metadata for a SecretVersion. `projects/x/secrets/x/versions/latest` is an alias to the `latest` SecretVersion. + * @alias secretmanager.projects.secrets.versions.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name of the SecretVersion in the format `projects/x/secrets/x/versions/x`. `projects/x/secrets/x/versions/latest` is an alias to the `latest` SecretVersion. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Projects$Secrets$Versions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Secrets$Versions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Secrets$Versions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Versions$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Versions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Versions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * secretmanager.projects.secrets.versions.list + * @desc Lists SecretVersions. This call does not return secret data. + * @alias secretmanager.projects.secrets.versions.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize Optional. The maximum number of results to be returned in a single page. If set to 0, the server decides the number of results to return. If the number is greater than 25000, it is capped at 25000. + * @param {string=} params.pageToken Optional. Pagination token, returned earlier via ListSecretVersionsResponse.next_page_token][]. + * @param {string} params.parent Required. The resource name of the Secret associated with the SecretVersions to list, in the format `projects/x/secrets/x`. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$Secrets$Versions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Secrets$Versions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Secrets$Versions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Versions$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Versions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Versions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/versions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Secrets$Versions$Access + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the SecretVersion in the format `projects/x/secrets/x/versions/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Secrets$Versions$Destroy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the SecretVersion to destroy in the format `projects/x/secrets/x/versions/x`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DestroySecretVersionRequest; + } + export interface Params$Resource$Projects$Secrets$Versions$Disable + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the SecretVersion to disable in the format `projects/x/secrets/x/versions/x`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DisableSecretVersionRequest; + } + export interface Params$Resource$Projects$Secrets$Versions$Enable + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the SecretVersion to enable in the format `projects/x/secrets/x/versions/x`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$EnableSecretVersionRequest; + } + export interface Params$Resource$Projects$Secrets$Versions$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the SecretVersion in the format `projects/x/secrets/x/versions/x`. `projects/x/secrets/x/versions/latest` is an alias to the `latest` SecretVersion. + */ + name?: string; + } + export interface Params$Resource$Projects$Secrets$Versions$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional. The maximum number of results to be returned in a single page. If set to 0, the server decides the number of results to return. If the number is greater than 25000, it is capped at 25000. + */ + pageSize?: number; + /** + * Optional. Pagination token, returned earlier via ListSecretVersionsResponse.next_page_token][]. + */ + pageToken?: string; + /** + * Required. The resource name of the Secret associated with the SecretVersions to list, in the format `projects/x/secrets/x`. + */ + parent?: string; + } +} diff --git a/src/apis/searchconsole/webpack.config.js b/src/apis/secretmanager/webpack.config.js similarity index 96% rename from src/apis/searchconsole/webpack.config.js rename to src/apis/secretmanager/webpack.config.js index 340379eb45f..1c2c57c97a8 100644 --- a/src/apis/searchconsole/webpack.config.js +++ b/src/apis/secretmanager/webpack.config.js @@ -22,8 +22,8 @@ module.exports = { extensions: ['.ts', '.js', '.json'], }, output: { - library: 'Searchconsole', - filename: 'searchconsole.min.js', + library: 'Secretmanager', + filename: 'secretmanager.min.js', path: path.resolve(__dirname, 'dist'), }, node: { diff --git a/src/apis/securitycenter/index.ts b/src/apis/securitycenter/index.ts index 1736720b782..01147bb8e6c 100644 --- a/src/apis/securitycenter/index.ts +++ b/src/apis/securitycenter/index.ts @@ -17,11 +17,13 @@ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; import {securitycenter_v1} from './v1'; import {securitycenter_v1beta1} from './v1beta1'; import {securitycenter_v1p1alpha1} from './v1p1alpha1'; +import {securitycenter_v1p1beta1} from './v1p1beta1'; export const VERSIONS = { v1: securitycenter_v1.Securitycenter, v1beta1: securitycenter_v1beta1.Securitycenter, v1p1alpha1: securitycenter_v1p1alpha1.Securitycenter, + v1p1beta1: securitycenter_v1p1beta1.Securitycenter, }; export function securitycenter(version: 'v1'): securitycenter_v1.Securitycenter; @@ -40,11 +42,18 @@ export function securitycenter( export function securitycenter( options: securitycenter_v1p1alpha1.Options ): securitycenter_v1p1alpha1.Securitycenter; +export function securitycenter( + version: 'v1p1beta1' +): securitycenter_v1p1beta1.Securitycenter; +export function securitycenter( + options: securitycenter_v1p1beta1.Options +): securitycenter_v1p1beta1.Securitycenter; export function securitycenter< T = | securitycenter_v1.Securitycenter | securitycenter_v1beta1.Securitycenter | securitycenter_v1p1alpha1.Securitycenter + | securitycenter_v1p1beta1.Securitycenter >( this: GoogleConfigurable, versionOrOptions: @@ -54,6 +63,8 @@ export function securitycenter< | securitycenter_v1beta1.Options | 'v1p1alpha1' | securitycenter_v1p1alpha1.Options + | 'v1p1beta1' + | securitycenter_v1p1beta1.Options ) { return getAPI('securitycenter', versionOrOptions, VERSIONS, this); } diff --git a/src/apis/securitycenter/v1.ts b/src/apis/securitycenter/v1.ts index 62af6bee0eb..b1c6e04ae03 100644 --- a/src/apis/securitycenter/v1.ts +++ b/src/apis/securitycenter/v1.ts @@ -196,7 +196,7 @@ export namespace securitycenter_v1 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -327,11 +327,11 @@ export namespace securitycenter_v1 { */ compareDuration?: string | null; /** - * Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form `<field> <operator> <value>` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: * name: `=` * update_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: "update_time = \"2019-06-10T16:07:18-07:00\"" "update_time = 1560208038000" * create_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: "create_time = \"2019-06-10T16:07:18-07:00\"" "create_time = 1560208038000" * iam_policy.policy_blob: `=`, `:` * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` * security_marks.marks: `=`, `:` * security_center_properties.resource_name: `=`, `:` * security_center_properties.resource_type: `=`, `:` * security_center_properties.resource_parent: `=`, `:` * security_center_properties.resource_project: `=`, `:` * security_center_properties.resource_owners: `=`, `:` For example, `resource_properties.size = 100` is a valid filter string. + * Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form `<field> <operator> <value>` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: * name: `=` * update_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: "update_time = \"2019-06-10T16:07:18-07:00\"" "update_time = 1560208038000" * create_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: "create_time = \"2019-06-10T16:07:18-07:00\"" "create_time = 1560208038000" * iam_policy.policy_blob: `=`, `:` * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` * security_marks.marks: `=`, `:` * security_center_properties.resource_name: `=`, `:` * security_center_properties.resource_display_name: `=`, `:` * security_center_properties.resource_type: `=`, `:` * security_center_properties.resource_parent: `=`, `:` * security_center_properties.resource_parent_display_name: `=`, `:` * security_center_properties.resource_project: `=`, `:` * security_center_properties.resource_project_display_name: `=`, `:` * security_center_properties.resource_owners: `=`, `:` For example, `resource_properties.size = 100` is a valid filter string. */ filter?: string | null; /** - * Required. Expression that defines what assets fields to use for grouping. The string value should follow SQL syntax: comma separated list of fields. For example: "security_center_properties.resource_project,security_center_properties.project". The following fields are supported when compare_duration is not set: * security_center_properties.resource_project * security_center_properties.resource_type * security_center_properties.resource_parent The following fields are supported when compare_duration is set: * security_center_properties.resource_type + * Required. Expression that defines what assets fields to use for grouping. The string value should follow SQL syntax: comma separated list of fields. For example: "security_center_properties.resource_project,security_center_properties.project". The following fields are supported when compare_duration is not set: * security_center_properties.resource_project * security_center_properties.resource_project_display_name * security_center_properties.resource_type * security_center_properties.resource_parent * security_center_properties.resource_parent_display_name The following fields are supported when compare_duration is set: * security_center_properties.resource_type * security_center_properties.resource_project_display_name * security_center_properties.resource_parent_display_name */ groupBy?: string | null; /** @@ -581,7 +581,7 @@ export namespace securitycenter_v1 { name?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -589,15 +589,15 @@ export namespace securitycenter_v1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if the incoming policy version does not meet the requirements for modifying the stored policy. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a binding (conditional or unconditional) from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, version compliance checks against the stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } @@ -634,6 +634,10 @@ export namespace securitycenter_v1 { * Cloud SCC managed properties. These properties are managed by Cloud SCC and cannot be modified by the user. */ export interface Schema$SecurityCenterProperties { + /** + * The user defined display name for this resource. + */ + resourceDisplayName?: string | null; /** * The full resource name of the GCP resource this asset represents. This field is immutable after create time. See: https://cloud.google.com/apis/design/resource_names#full_resource_name */ @@ -646,10 +650,18 @@ export namespace securitycenter_v1 { * The full resource name of the immediate parent of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name */ resourceParent?: string | null; + /** + * The user defined display name for the parent of this resource. + */ + resourceParentDisplayName?: string | null; /** * The full resource name of the project the resource belongs to. See: https://cloud.google.com/apis/design/resource_names#full_resource_name */ resourceProject?: string | null; + /** + * The user defined display name for the project of this resource. + */ + resourceProjectDisplayName?: string | null; /** * The type of the GCP resource. Examples include: APPLICATION, PROJECT, and ORGANIZATION. This is a case insensitive field defined by Cloud SCC and/or the producer of the resource and is immutable after create time. */ @@ -1264,8 +1276,8 @@ export namespace securitycenter_v1 { * @param {object} params Parameters for request * @param {string=} params.compareDuration When compare_duration is set, the ListAssetsResult's "state_change" attribute is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible "state_change" values when compare_duration is specified: * "ADDED": indicates that the asset was not present at the start of compare_duration, but present at read_time. * "REMOVED": indicates that the asset was present at the start of compare_duration, but not present at read_time. * "ACTIVE": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and read_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all assets present at read_time. * @param {string=} params.fieldMask Optional. A field mask to specify the ListAssetsResult fields to be listed in the response. An empty field mask will list all fields. - * @param {string=} params.filter Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following are the allowed field and operator combinations: * name: `=` * update_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: "update_time = \"2019-06-10T16:07:18-07:00\"" "update_time = 1560208038000" * create_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: "create_time = \"2019-06-10T16:07:18-07:00\"" "create_time = 1560208038000" * iam_policy.policy_blob: `=`, `:` * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` * security_marks.marks: `=`, `:` * security_center_properties.resource_name: `=`, `:` * security_center_properties.resource_type: `=`, `:` * security_center_properties.resource_parent: `=`, `:` * security_center_properties.resource_project: `=`, `:` * security_center_properties.resource_owners: `=`, `:` For example, `resource_properties.size = 100` is a valid filter string. - * @param {string=} params.orderBy Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,resource_properties.a_property". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,resource_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,resource_properties.a_property" and " name desc , resource_properties.a_property " are equivalent. The following fields are supported: name update_time resource_properties security_marks.marks security_center_properties.resource_name security_center_properties.resource_parent security_center_properties.resource_project security_center_properties.resource_type + * @param {string=} params.filter Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following are the allowed field and operator combinations: * name: `=` * update_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: "update_time = \"2019-06-10T16:07:18-07:00\"" "update_time = 1560208038000" * create_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: "create_time = \"2019-06-10T16:07:18-07:00\"" "create_time = 1560208038000" * iam_policy.policy_blob: `=`, `:` * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` * security_marks.marks: `=`, `:` * security_center_properties.resource_name: `=`, `:` * security_center_properties.resource_display_name: `=`, `:` * security_center_properties.resource_type: `=`, `:` * security_center_properties.resource_parent: `=`, `:` * security_center_properties.resource_parent_display_name: `=`, `:` * security_center_properties.resource_project: `=`, `:` * security_center_properties.resource_project_display_name: `=`, `:` * security_center_properties.resource_owners: `=`, `:` For example, `resource_properties.size = 100` is a valid filter string. + * @param {string=} params.orderBy Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,resource_properties.a_property". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,resource_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,resource_properties.a_property" and " name desc , resource_properties.a_property " are equivalent. The following fields are supported: name update_time resource_properties security_marks.marks security_center_properties.resource_name security_center_properties.resource_display_name security_center_properties.resource_parent security_center_properties.resource_parent_display_name security_center_properties.resource_project security_center_properties.resource_project_display_name security_center_properties.resource_type * @param {integer=} params.pageSize The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. * @param {string=} params.pageToken The value returned by the last `ListAssetsResponse`; indicates that this is a continuation of a prior `ListAssets` call, and that the system should return the next page of data. * @param {string} params.parent Required. Name of the organization assets should belong to. Its format is "organizations/[organization_id]". @@ -1630,11 +1642,11 @@ export namespace securitycenter_v1 { */ fieldMask?: string; /** - * Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following are the allowed field and operator combinations: * name: `=` * update_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: "update_time = \"2019-06-10T16:07:18-07:00\"" "update_time = 1560208038000" * create_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: "create_time = \"2019-06-10T16:07:18-07:00\"" "create_time = 1560208038000" * iam_policy.policy_blob: `=`, `:` * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` * security_marks.marks: `=`, `:` * security_center_properties.resource_name: `=`, `:` * security_center_properties.resource_type: `=`, `:` * security_center_properties.resource_parent: `=`, `:` * security_center_properties.resource_project: `=`, `:` * security_center_properties.resource_owners: `=`, `:` For example, `resource_properties.size = 100` is a valid filter string. + * Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following are the allowed field and operator combinations: * name: `=` * update_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: "update_time = \"2019-06-10T16:07:18-07:00\"" "update_time = 1560208038000" * create_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: "create_time = \"2019-06-10T16:07:18-07:00\"" "create_time = 1560208038000" * iam_policy.policy_blob: `=`, `:` * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` * security_marks.marks: `=`, `:` * security_center_properties.resource_name: `=`, `:` * security_center_properties.resource_display_name: `=`, `:` * security_center_properties.resource_type: `=`, `:` * security_center_properties.resource_parent: `=`, `:` * security_center_properties.resource_parent_display_name: `=`, `:` * security_center_properties.resource_project: `=`, `:` * security_center_properties.resource_project_display_name: `=`, `:` * security_center_properties.resource_owners: `=`, `:` For example, `resource_properties.size = 100` is a valid filter string. */ filter?: string; /** - * Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,resource_properties.a_property". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,resource_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,resource_properties.a_property" and " name desc , resource_properties.a_property " are equivalent. The following fields are supported: name update_time resource_properties security_marks.marks security_center_properties.resource_name security_center_properties.resource_parent security_center_properties.resource_project security_center_properties.resource_type + * Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,resource_properties.a_property". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,resource_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,resource_properties.a_property" and " name desc , resource_properties.a_property " are equivalent. The following fields are supported: name update_time resource_properties security_marks.marks security_center_properties.resource_name security_center_properties.resource_display_name security_center_properties.resource_parent security_center_properties.resource_parent_display_name security_center_properties.resource_project security_center_properties.resource_project_display_name security_center_properties.resource_type */ orderBy?: string; /** diff --git a/src/apis/securitycenter/v1beta1.ts b/src/apis/securitycenter/v1beta1.ts index 752c5529bfd..690ed125036 100644 --- a/src/apis/securitycenter/v1beta1.ts +++ b/src/apis/securitycenter/v1beta1.ts @@ -192,7 +192,7 @@ export namespace securitycenter_v1beta1 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -543,7 +543,7 @@ export namespace securitycenter_v1beta1 { name?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -551,15 +551,15 @@ export namespace securitycenter_v1beta1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if the incoming policy version does not meet the requirements for modifying the stored policy. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a binding (conditional or unconditional) from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, version compliance checks against the stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } diff --git a/src/apis/securitycenter/v1p1beta1.ts b/src/apis/securitycenter/v1p1beta1.ts new file mode 100644 index 00000000000..5c09042bd4c --- /dev/null +++ b/src/apis/securitycenter/v1p1beta1.ts @@ -0,0 +1,572 @@ +// Copyright 2019 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, +} from 'google-auth-library'; +import { + GoogleConfigurable, + createAPIRequest, + MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace securitycenter_v1p1beta1 { + export interface Options extends GlobalOptions { + version: 'v1p1beta1'; + } + + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * Cloud Security Command Center API + * + * Cloud Security Command Center API provides access to temporal views of assets and findings within an organization. + * + * @example + * const {google} = require('googleapis'); + * const securitycenter = google.securitycenter('v1p1beta1'); + * + * @namespace securitycenter + * @type {Function} + * @version v1p1beta1 + * @variation v1p1beta1 + * @param {object=} options Options for Securitycenter + */ + export class Securitycenter { + context: APIRequestContext; + organizations: Resource$Organizations; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.organizations = new Resource$Organizations(this.context); + } + } + + /** + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + */ + export interface Schema$Empty {} + /** + * Response of asset discovery run + */ + export interface Schema$GoogleCloudSecuritycenterV1beta1RunAssetDiscoveryResponse { + /** + * The duration between asset discovery run start and end + */ + duration?: string | null; + /** + * The state of an asset discovery run. + */ + state?: string | null; + } + /** + * Response of asset discovery run + */ + export interface Schema$GoogleCloudSecuritycenterV1RunAssetDiscoveryResponse { + /** + * The duration between asset discovery run start and end + */ + duration?: string | null; + /** + * The state of an asset discovery run. + */ + state?: string | null; + } + /** + * The response message for Operations.ListOperations. + */ + export interface Schema$ListOperationsResponse { + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + /** + * A list of operations that matches the specified filter in the request. + */ + operations?: Schema$Operation[]; + } + /** + * This resource represents a long-running operation that is the result of a network API call. + */ + export interface Schema$Operation { + /** + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. + */ + done?: boolean | null; + /** + * The error result of the operation in case of failure or cancellation. + */ + error?: Schema$Status; + /** + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + */ + metadata?: {[key: string]: any} | null; + /** + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. + */ + name?: string | null; + /** + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + */ + response?: {[key: string]: any} | null; + } + /** + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + */ + export interface Schema$Status { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number | null; + /** + * A list of messages that carry the error details. There is a common set of message types for APIs to use. + */ + details?: Array<{[key: string]: any}> | null; + /** + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + */ + message?: string | null; + } + + export class Resource$Organizations { + context: APIRequestContext; + operations: Resource$Organizations$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Organizations$Operations(this.context); + } + } + + export class Resource$Organizations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * securitycenter.organizations.operations.cancel + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * @alias securitycenter.organizations.operations.cancel + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the operation resource to be cancelled. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + cancel( + params?: Params$Resource$Organizations$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Organizations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Organizations$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Organizations$Operations$Cancel + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://securitycenter.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * securitycenter.organizations.operations.delete + * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * @alias securitycenter.organizations.operations.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the operation resource to be deleted. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Organizations$Operations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Organizations$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Organizations$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Organizations$Operations$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://securitycenter.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * securitycenter.organizations.operations.get + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @alias securitycenter.organizations.operations.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the operation resource. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Organizations$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Organizations$Operations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Organizations$Operations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Organizations$Operations$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://securitycenter.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * securitycenter.organizations.operations.list + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. + * @alias securitycenter.organizations.operations.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter The standard list filter. + * @param {string} params.name The name of the operation's parent resource. + * @param {integer=} params.pageSize The standard list page size. + * @param {string=} params.pageToken The standard list page token. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Organizations$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Organizations$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Operations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Organizations$Operations$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://securitycenter.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Organizations$Operations$Cancel + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Organizations$Operations$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Organizations$Operations$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Organizations$Operations$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } +} diff --git a/src/apis/servicebroker/v1.ts b/src/apis/servicebroker/v1.ts index 93de2a2a28c..ee8a0ecc97d 100644 --- a/src/apis/servicebroker/v1.ts +++ b/src/apis/servicebroker/v1.ts @@ -124,7 +124,7 @@ export namespace servicebroker_v1 { */ condition?: Schema$GoogleType__Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -133,19 +133,19 @@ export namespace servicebroker_v1 { role?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$GoogleIamV1__Policy { /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$GoogleIamV1__Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if the incoming policy version does not meet the requirements for modifying the stored policy. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a binding (conditional or unconditional) from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, version compliance checks against the stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } diff --git a/src/apis/servicebroker/v1alpha1.ts b/src/apis/servicebroker/v1alpha1.ts index 062b6afdd43..1152f16f029 100644 --- a/src/apis/servicebroker/v1alpha1.ts +++ b/src/apis/servicebroker/v1alpha1.ts @@ -473,7 +473,7 @@ export namespace servicebroker_v1alpha1 { */ condition?: Schema$GoogleType__Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -482,19 +482,19 @@ export namespace servicebroker_v1alpha1 { role?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$GoogleIamV1__Policy { /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$GoogleIamV1__Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if the incoming policy version does not meet the requirements for modifying the stored policy. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a binding (conditional or unconditional) from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, version compliance checks against the stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } diff --git a/src/apis/servicebroker/v1beta1.ts b/src/apis/servicebroker/v1beta1.ts index 7650e92c791..bba73a816a5 100644 --- a/src/apis/servicebroker/v1beta1.ts +++ b/src/apis/servicebroker/v1beta1.ts @@ -531,7 +531,7 @@ export namespace servicebroker_v1beta1 { */ condition?: Schema$GoogleType__Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -540,19 +540,19 @@ export namespace servicebroker_v1beta1 { role?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$GoogleIamV1__Policy { /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$GoogleIamV1__Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if the incoming policy version does not meet the requirements for modifying the stored policy. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a binding (conditional or unconditional) from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, version compliance checks against the stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } diff --git a/src/apis/serviceconsumermanagement/v1.ts b/src/apis/serviceconsumermanagement/v1.ts index 10837bf99f1..6f508419cb1 100644 --- a/src/apis/serviceconsumermanagement/v1.ts +++ b/src/apis/serviceconsumermanagement/v1.ts @@ -287,7 +287,11 @@ export namespace serviceconsumermanagement_v1 { */ deadline?: number | null; /** - * The JWT audience is used when generating a JWT id token for the backend. + * When disable_auth is false, a JWT ID token will be generated with the value from BackendRule.address as jwt_audience, overrode to the HTTP "Authorization" request header and sent to the backend. When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header. + */ + disableAuth?: boolean | null; + /** + * The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend. */ jwtAudience?: string | null; /** @@ -823,7 +827,7 @@ export namespace serviceconsumermanagement_v1 { */ type?: string | null; /** - * The unit in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The supported units are a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day **Prefixes (PREFIX)** * `k` kilo (10**3) * `M` mega (10**6) * `G` giga (10**9) * `T` tera (10**12) * `P` peta (10**15) * `E` exa (10**18) * `Z` zetta (10**21) * `Y` yotta (10**24) * `m` milli (10**-3) * `u` micro (10**-6) * `n` nano (10**-9) * `p` pico (10**-12) * `f` femto (10**-15) * `a` atto (10**-18) * `z` zepto (10**-21) * `y` yocto (10**-24) * `Ki` kibi (2**10) * `Mi` mebi (2**20) * `Gi` gibi (2**30) * `Ti` tebi (2**40) **Grammar** The grammar also includes these connectors: * `/` division (as an infix operator, e.g. `1/s`). * `.` multiplication (as an infix operator, e.g. `GBy.d`) The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a comment if it follows a `UNIT` and is equivalent to `1` if it is used alone. For examples, `{requests}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing '{' or '}'. * `1` represents dimensionless value 1, such as in `1/s`. * `%` represents dimensionless value 1/100, and annotates values giving a percentage. + * The units in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the representation of the stored metric values. Different systems may scale the values to be more easily displayed (so a value of `0.02KBy` _might_ be displayed as `20By`, and a value of `3523KBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is `KBy`, then the value of the metric is always in thousands of bytes, no matter how it may be displayed.. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just `s`). If the job uses 12,005 CPU-seconds, then the value is written as `12005`. Alternatively, if you want a custom metric to record data in a more granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is `ks{CPU}`, and then write the value `12.005` (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which is `12005/1024`). The supported units are a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For examples, `kBy/{email}` or `MiBy/10ms` (although you should almost never have `/s` in a metric `unit`; rates should always be computed at query time from the underlying cumulative or delta value). * `.` multiplication or composition (as an infix operator). For examples, `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a comment if it follows a `UNIT`. If the annotation is used alone, then the unit is equivalent to `1`. For examples, `{request}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing `{` or `}`. * `1` represents a unitary [dimensionless unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in `1/s`. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a metric value of `5.3` would mean "5300 page views per day"). * `%` represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value `3` means "3 percent"). * `10^2.%` indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value `0.03` means "3 percent"). */ unit?: string | null; /** @@ -1532,6 +1536,23 @@ export namespace serviceconsumermanagement_v1 { */ uniqueId?: string | null; } + /** + * A default identity in the Identity and Access Management API. + */ + export interface Schema$V1DefaultIdentity { + /** + * The email address of the default identity. + */ + email?: string | null; + /** + * Default identity resource name. An example name would be: `services/serviceconsumermanagement.googleapis.com/projects/123/defaultIdentity` + */ + name?: string | null; + /** + * The unique and stable id of the default identity. + */ + uniqueId?: string | null; + } /** * Response message for the `DisableConsumer` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. */ @@ -1540,6 +1561,23 @@ export namespace serviceconsumermanagement_v1 { * Response message for the `EnableConsumer` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. */ export interface Schema$V1EnableConsumerResponse {} + /** + * Response message for the `GenerateDefaultIdentity` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. + */ + export interface Schema$V1GenerateDefaultIdentityResponse { + /** + * Status of the role attachment. Under development (go/si-attach-role), currently always return ATTACH_STATUS_UNSPECIFIED) + */ + attachStatus?: string | null; + /** + * DefaultIdentity that was created or retrieved. + */ + identity?: Schema$V1DefaultIdentity; + /** + * Role attached to consumer project. Empty if not attached in this request. (Under development, currently always return empty.) + */ + role?: string | null; + } /** * Response message for the `GenerateServiceAccount` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. */ diff --git a/src/apis/servicecontrol/v1.ts b/src/apis/servicecontrol/v1.ts index 61d74478741..b63066ebcde 100644 --- a/src/apis/servicecontrol/v1.ts +++ b/src/apis/servicecontrol/v1.ts @@ -695,7 +695,7 @@ export namespace servicecontrol_v1 { */ int64Value?: string | null; /** - * The labels describing the metric value. See comments on google.api.servicecontrol.v1.Operation.labels for the overriding relationship. + * The labels describing the metric value. See comments on google.api.servicecontrol.v1.Operation.labels for the overriding relationship. Note that this map must not contain monitored resource labels. */ labels?: {[key: string]: string} | null; /** @@ -922,7 +922,7 @@ export namespace servicecontrol_v1 { */ export interface Schema$ReportRequest { /** - * Operations to be reported. Typically the service should report one operation per request. Putting multiple operations into a single request is allowed, but should be used only when multiple operations are natually available at the time of the report. If multiple operations are in a single request, the total request size should be no larger than 1MB. See ReportResponse.report_errors for partial failure behavior. + * Operations to be reported. Typically the service should report one operation per request. Putting multiple operations into a single request is allowed, but should be used only when multiple operations are natually available at the time of the report. There is no limit on the number of operations in the same ReportRequest, however the ReportRequest size should be no larger than 1MB. See ReportResponse.report_errors for partial failure behavior. */ operations?: Schema$Operation[]; /** @@ -984,7 +984,7 @@ export namespace servicecontrol_v1 { */ protocol?: string | null; /** - * The HTTP URL query in the format of `name1=value`&name2=value2`, as it appears in the first line of the HTTP request. No decoding is performed. + * The HTTP URL query in the format of `name1=value1&name2=value2`, as it appears in the first line of the HTTP request. No decoding is performed. */ query?: string | null; /** @@ -1093,6 +1093,15 @@ export namespace servicecontrol_v1 { */ thirdPartyPrincipal?: Schema$ThirdPartyPrincipal; } + /** + * The context of a span, attached to google.api.Distribution.Exemplars in google.api.Distribution values during aggregation. It contains the name of a span with format: projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID] + */ + export interface Schema$SpanContext { + /** + * The resource name of the span in the following format: projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. [SPAN_ID] is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. + */ + spanName?: string | null; + } /** * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ @@ -1283,7 +1292,7 @@ export namespace servicecontrol_v1 { /** * servicecontrol.services.report - * @desc Reports operation results to Google Service Control, such as logs and metrics. It should be called after an operation is completed. If feasible, the client should aggregate reporting data for up to 5 seconds to reduce API traffic. Limiting aggregation to 5 seconds is to reduce data loss during client crashes. Clients should carefully choose the aggregation time window to avoid data loss risk more than 0.01% for business and compliance reasons. NOTE: the ReportRequest has the size limit of 1MB. This method requires the `servicemanagement.services.report` permission on the specified service. For more information, see [Google Cloud IAM](https://cloud.google.com/iam). + * @desc Reports operation results to Google Service Control, such as logs and metrics. It should be called after an operation is completed. If feasible, the client should aggregate reporting data for up to 5 seconds to reduce API traffic. Limiting aggregation to 5 seconds is to reduce data loss during client crashes. Clients should carefully choose the aggregation time window to avoid data loss risk more than 0.01% for business and compliance reasons. NOTE: the ReportRequest has the size limit (wire-format byte size) of 1MB. This method requires the `servicemanagement.services.report` permission on the specified service. For more information, see [Google Cloud IAM](https://cloud.google.com/iam). * @alias servicecontrol.services.report * @memberOf! () * diff --git a/src/apis/servicemanagement/v1.ts b/src/apis/servicemanagement/v1.ts index b4e478a98f5..161fbc6581a 100644 --- a/src/apis/servicemanagement/v1.ts +++ b/src/apis/servicemanagement/v1.ts @@ -279,7 +279,11 @@ export namespace servicemanagement_v1 { */ deadline?: number | null; /** - * The JWT audience is used when generating a JWT id token for the backend. + * When disable_auth is false, a JWT ID token will be generated with the value from BackendRule.address as jwt_audience, overrode to the HTTP "Authorization" request header and sent to the backend. When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header. + */ + disableAuth?: boolean | null; + /** + * The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend. */ jwtAudience?: string | null; /** @@ -327,7 +331,7 @@ export namespace servicemanagement_v1 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -1042,7 +1046,7 @@ export namespace servicemanagement_v1 { */ type?: string | null; /** - * The unit in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The supported units are a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day **Prefixes (PREFIX)** * `k` kilo (10**3) * `M` mega (10**6) * `G` giga (10**9) * `T` tera (10**12) * `P` peta (10**15) * `E` exa (10**18) * `Z` zetta (10**21) * `Y` yotta (10**24) * `m` milli (10**-3) * `u` micro (10**-6) * `n` nano (10**-9) * `p` pico (10**-12) * `f` femto (10**-15) * `a` atto (10**-18) * `z` zepto (10**-21) * `y` yocto (10**-24) * `Ki` kibi (2**10) * `Mi` mebi (2**20) * `Gi` gibi (2**30) * `Ti` tebi (2**40) **Grammar** The grammar also includes these connectors: * `/` division (as an infix operator, e.g. `1/s`). * `.` multiplication (as an infix operator, e.g. `GBy.d`) The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a comment if it follows a `UNIT` and is equivalent to `1` if it is used alone. For examples, `{requests}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing '{' or '}'. * `1` represents dimensionless value 1, such as in `1/s`. * `%` represents dimensionless value 1/100, and annotates values giving a percentage. + * The units in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the representation of the stored metric values. Different systems may scale the values to be more easily displayed (so a value of `0.02KBy` _might_ be displayed as `20By`, and a value of `3523KBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is `KBy`, then the value of the metric is always in thousands of bytes, no matter how it may be displayed.. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just `s`). If the job uses 12,005 CPU-seconds, then the value is written as `12005`. Alternatively, if you want a custom metric to record data in a more granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is `ks{CPU}`, and then write the value `12.005` (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which is `12005/1024`). The supported units are a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For examples, `kBy/{email}` or `MiBy/10ms` (although you should almost never have `/s` in a metric `unit`; rates should always be computed at query time from the underlying cumulative or delta value). * `.` multiplication or composition (as an infix operator). For examples, `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a comment if it follows a `UNIT`. If the annotation is used alone, then the unit is equivalent to `1`. For examples, `{request}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing `{` or `}`. * `1` represents a unitary [dimensionless unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in `1/s`. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a metric value of `5.3` would mean "5300 page views per day"). * `%` represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value `3` means "3 percent"). * `10^2.%` indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value `0.03` means "3 percent"). */ unit?: string | null; /** @@ -1234,7 +1238,7 @@ export namespace servicemanagement_v1 { subpages?: Schema$Page[]; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -1242,15 +1246,15 @@ export namespace servicemanagement_v1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if the incoming policy version does not meet the requirements for modifying the stored policy. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a binding (conditional or unconditional) from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, version compliance checks against the stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } diff --git a/src/apis/servicenetworking/v1.ts b/src/apis/servicenetworking/v1.ts index 1de0aaaf0ca..62ae43d7312 100644 --- a/src/apis/servicenetworking/v1.ts +++ b/src/apis/servicenetworking/v1.ts @@ -281,7 +281,11 @@ export namespace servicenetworking_v1 { */ deadline?: number | null; /** - * The JWT audience is used when generating a JWT id token for the backend. + * When disable_auth is false, a JWT ID token will be generated with the value from BackendRule.address as jwt_audience, overrode to the HTTP "Authorization" request header and sent to the backend. When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header. + */ + disableAuth?: boolean | null; + /** + * The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend. */ jwtAudience?: string | null; /** @@ -436,6 +440,15 @@ export namespace servicenetworking_v1 { */ path?: string | null; } + /** + * Request to disable VPC service controls. + */ + export interface Schema$DisableVpcServiceControlsRequest { + /** + * Required. The network that the consumer is using to connect with services. Must be in the form of projects/{project}/global/networks/{network} {project} is a project number, as in '12345' {network} is network name. + */ + consumerNetwork?: string | null; + } /** * `Documentation` provides the information for describing a service. Example: <pre><code>documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: &#40;== include google/foo/overview.md ==&#41; - name: Tutorial content: &#40;== include google/foo/tutorial.md ==&#41; subpages; - name: Java content: &#40;== include google/foo/tutorial_java.md ==&#41; rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... </code></pre> Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: <pre><code>&#91;fully.qualified.proto.name]&#91;]</code></pre> To override the display text used for the link, this can be used: <pre><code>&#91;display text]&#91;fully.qualified.proto.name]</code></pre> Text can be excluded from doc using the following notation: <pre><code>&#40;-- internal comment --&#41;</code></pre> A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: <pre><code>&#40;== include path/to/file ==&#41;</code></pre> The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: <pre><code>&#40;== resource_for v1.shelves.books ==&#41;</code></pre> The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. */ @@ -486,6 +499,15 @@ export namespace servicenetworking_v1 { * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} + /** + * Request to enable VPC service controls. + */ + export interface Schema$EnableVpcServiceControlsRequest { + /** + * Required. The network that the consumer is using to connect with services. Must be in the form of projects/{project}/global/networks/{network} {project} is a project number, as in '12345' {network} is network name. + */ + consumerNetwork?: string | null; + } /** * `Endpoint` describes a network endpoint that serves a set of APIs. A service may expose any number of endpoints, and all endpoints share the same service configuration, such as quota configuration and monitoring configuration. Example service configuration: name: library-example.googleapis.com endpoints: # Below entry makes 'google.example.library.v1.Library' # API be served from endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS calls to be passed to the backend, for # it to decide whether the subsequent cross-origin request is # allowed to proceed. - name: library-example.googleapis.com allow_cors: true */ @@ -837,7 +859,7 @@ export namespace servicenetworking_v1 { */ type?: string | null; /** - * The unit in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The supported units are a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day **Prefixes (PREFIX)** * `k` kilo (10**3) * `M` mega (10**6) * `G` giga (10**9) * `T` tera (10**12) * `P` peta (10**15) * `E` exa (10**18) * `Z` zetta (10**21) * `Y` yotta (10**24) * `m` milli (10**-3) * `u` micro (10**-6) * `n` nano (10**-9) * `p` pico (10**-12) * `f` femto (10**-15) * `a` atto (10**-18) * `z` zepto (10**-21) * `y` yocto (10**-24) * `Ki` kibi (2**10) * `Mi` mebi (2**20) * `Gi` gibi (2**30) * `Ti` tebi (2**40) **Grammar** The grammar also includes these connectors: * `/` division (as an infix operator, e.g. `1/s`). * `.` multiplication (as an infix operator, e.g. `GBy.d`) The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a comment if it follows a `UNIT` and is equivalent to `1` if it is used alone. For examples, `{requests}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing '{' or '}'. * `1` represents dimensionless value 1, such as in `1/s`. * `%` represents dimensionless value 1/100, and annotates values giving a percentage. + * The units in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the representation of the stored metric values. Different systems may scale the values to be more easily displayed (so a value of `0.02KBy` _might_ be displayed as `20By`, and a value of `3523KBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is `KBy`, then the value of the metric is always in thousands of bytes, no matter how it may be displayed.. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just `s`). If the job uses 12,005 CPU-seconds, then the value is written as `12005`. Alternatively, if you want a custom metric to record data in a more granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is `ks{CPU}`, and then write the value `12.005` (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which is `12005/1024`). The supported units are a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For examples, `kBy/{email}` or `MiBy/10ms` (although you should almost never have `/s` in a metric `unit`; rates should always be computed at query time from the underlying cumulative or delta value). * `.` multiplication or composition (as an infix operator). For examples, `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a comment if it follows a `UNIT`. If the annotation is used alone, then the unit is equivalent to `1`. For examples, `{request}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing `{` or `}`. * `1` represents a unitary [dimensionless unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in `1/s`. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a metric value of `5.3` would mean "5300 page views per day"). * `%` represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value `3` means "3 percent"). * `10^2.%` indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value `0.03` means "3 percent"). */ unit?: string | null; /** @@ -1837,6 +1859,162 @@ export namespace servicenetworking_v1 { } } + /** + * servicenetworking.services.disableVpcServiceControls + * @desc Disables VPC service controls for a connection. + * @alias servicenetworking.services.disableVpcServiceControls + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is `services/servicenetworking.googleapis.com`. + * @param {().DisableVpcServiceControlsRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + disableVpcServiceControls( + params?: Params$Resource$Services$Disablevpcservicecontrols, + options?: MethodOptions + ): GaxiosPromise; + disableVpcServiceControls( + params: Params$Resource$Services$Disablevpcservicecontrols, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + disableVpcServiceControls( + params: Params$Resource$Services$Disablevpcservicecontrols, + callback: BodyResponseCallback + ): void; + disableVpcServiceControls( + callback: BodyResponseCallback + ): void; + disableVpcServiceControls( + paramsOrCallback?: + | Params$Resource$Services$Disablevpcservicecontrols + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Services$Disablevpcservicecontrols; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Services$Disablevpcservicecontrols; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://servicenetworking.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}:disableVpcServiceControls').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * servicenetworking.services.enableVpcServiceControls + * @desc Enables VPC service controls for a connection. + * @alias servicenetworking.services.enableVpcServiceControls + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is `services/servicenetworking.googleapis.com`. + * @param {().EnableVpcServiceControlsRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + enableVpcServiceControls( + params?: Params$Resource$Services$Enablevpcservicecontrols, + options?: MethodOptions + ): GaxiosPromise; + enableVpcServiceControls( + params: Params$Resource$Services$Enablevpcservicecontrols, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + enableVpcServiceControls( + params: Params$Resource$Services$Enablevpcservicecontrols, + callback: BodyResponseCallback + ): void; + enableVpcServiceControls( + callback: BodyResponseCallback + ): void; + enableVpcServiceControls( + paramsOrCallback?: + | Params$Resource$Services$Enablevpcservicecontrols + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Services$Enablevpcservicecontrols; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Services$Enablevpcservicecontrols; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://servicenetworking.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}:enableVpcServiceControls').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * servicenetworking.services.searchRange * @desc Service producers can use this method to find a currently unused range within consumer allocated ranges. This returned range is not reserved, and not guaranteed to remain unused. It will validate previously provided allocated ranges, find non-conflicting sub-range of requested size (expressed in number of leading bits of ipv4 network mask, as in CIDR range notation). Operation @@ -2016,6 +2194,40 @@ export namespace servicenetworking_v1 { */ requestBody?: Schema$AddSubnetworkRequest; } + export interface Params$Resource$Services$Disablevpcservicecontrols + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is `services/servicenetworking.googleapis.com`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DisableVpcServiceControlsRequest; + } + export interface Params$Resource$Services$Enablevpcservicecontrols + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is `services/servicenetworking.googleapis.com`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$EnableVpcServiceControlsRequest; + } export interface Params$Resource$Services$Searchrange extends StandardParameters { /** diff --git a/src/apis/servicenetworking/v1beta.ts b/src/apis/servicenetworking/v1beta.ts index 270e8bd84c7..c4f5c2be462 100644 --- a/src/apis/servicenetworking/v1beta.ts +++ b/src/apis/servicenetworking/v1beta.ts @@ -281,7 +281,11 @@ export namespace servicenetworking_v1beta { */ deadline?: number | null; /** - * The JWT audience is used when generating a JWT id token for the backend. + * When disable_auth is false, a JWT ID token will be generated with the value from BackendRule.address as jwt_audience, overrode to the HTTP "Authorization" request header and sent to the backend. When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header. + */ + disableAuth?: boolean | null; + /** + * The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend. */ jwtAudience?: string | null; /** @@ -807,7 +811,7 @@ export namespace servicenetworking_v1beta { */ type?: string | null; /** - * The unit in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The supported units are a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day **Prefixes (PREFIX)** * `k` kilo (10**3) * `M` mega (10**6) * `G` giga (10**9) * `T` tera (10**12) * `P` peta (10**15) * `E` exa (10**18) * `Z` zetta (10**21) * `Y` yotta (10**24) * `m` milli (10**-3) * `u` micro (10**-6) * `n` nano (10**-9) * `p` pico (10**-12) * `f` femto (10**-15) * `a` atto (10**-18) * `z` zepto (10**-21) * `y` yocto (10**-24) * `Ki` kibi (2**10) * `Mi` mebi (2**20) * `Gi` gibi (2**30) * `Ti` tebi (2**40) **Grammar** The grammar also includes these connectors: * `/` division (as an infix operator, e.g. `1/s`). * `.` multiplication (as an infix operator, e.g. `GBy.d`) The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a comment if it follows a `UNIT` and is equivalent to `1` if it is used alone. For examples, `{requests}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing '{' or '}'. * `1` represents dimensionless value 1, such as in `1/s`. * `%` represents dimensionless value 1/100, and annotates values giving a percentage. + * The units in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the representation of the stored metric values. Different systems may scale the values to be more easily displayed (so a value of `0.02KBy` _might_ be displayed as `20By`, and a value of `3523KBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is `KBy`, then the value of the metric is always in thousands of bytes, no matter how it may be displayed.. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just `s`). If the job uses 12,005 CPU-seconds, then the value is written as `12005`. Alternatively, if you want a custom metric to record data in a more granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is `ks{CPU}`, and then write the value `12.005` (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which is `12005/1024`). The supported units are a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For examples, `kBy/{email}` or `MiBy/10ms` (although you should almost never have `/s` in a metric `unit`; rates should always be computed at query time from the underlying cumulative or delta value). * `.` multiplication or composition (as an infix operator). For examples, `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a comment if it follows a `UNIT`. If the annotation is used alone, then the unit is equivalent to `1`. For examples, `{request}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing `{` or `}`. * `1` represents a unitary [dimensionless unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in `1/s`. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a metric value of `5.3` would mean "5300 page views per day"). * `%` represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value `3` means "3 percent"). * `10^2.%` indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value `0.03` means "3 percent"). */ unit?: string | null; /** diff --git a/src/apis/serviceusage/v1.ts b/src/apis/serviceusage/v1.ts index 35241656db8..de5af5c8598 100644 --- a/src/apis/serviceusage/v1.ts +++ b/src/apis/serviceusage/v1.ts @@ -244,7 +244,11 @@ export namespace serviceusage_v1 { */ deadline?: number | null; /** - * The JWT audience is used when generating a JWT id token for the backend. + * When disable_auth is false, a JWT ID token will be generated with the value from BackendRule.address as jwt_audience, overrode to the HTTP "Authorization" request header and sent to the backend. When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header. + */ + disableAuth?: boolean | null; + /** + * The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend. */ jwtAudience?: string | null; /** @@ -1056,7 +1060,7 @@ export namespace serviceusage_v1 { */ type?: string | null; /** - * The unit in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The supported units are a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day **Prefixes (PREFIX)** * `k` kilo (10**3) * `M` mega (10**6) * `G` giga (10**9) * `T` tera (10**12) * `P` peta (10**15) * `E` exa (10**18) * `Z` zetta (10**21) * `Y` yotta (10**24) * `m` milli (10**-3) * `u` micro (10**-6) * `n` nano (10**-9) * `p` pico (10**-12) * `f` femto (10**-15) * `a` atto (10**-18) * `z` zepto (10**-21) * `y` yocto (10**-24) * `Ki` kibi (2**10) * `Mi` mebi (2**20) * `Gi` gibi (2**30) * `Ti` tebi (2**40) **Grammar** The grammar also includes these connectors: * `/` division (as an infix operator, e.g. `1/s`). * `.` multiplication (as an infix operator, e.g. `GBy.d`) The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a comment if it follows a `UNIT` and is equivalent to `1` if it is used alone. For examples, `{requests}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing '{' or '}'. * `1` represents dimensionless value 1, such as in `1/s`. * `%` represents dimensionless value 1/100, and annotates values giving a percentage. + * The units in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the representation of the stored metric values. Different systems may scale the values to be more easily displayed (so a value of `0.02KBy` _might_ be displayed as `20By`, and a value of `3523KBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is `KBy`, then the value of the metric is always in thousands of bytes, no matter how it may be displayed.. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just `s`). If the job uses 12,005 CPU-seconds, then the value is written as `12005`. Alternatively, if you want a custom metric to record data in a more granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is `ks{CPU}`, and then write the value `12.005` (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which is `12005/1024`). The supported units are a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For examples, `kBy/{email}` or `MiBy/10ms` (although you should almost never have `/s` in a metric `unit`; rates should always be computed at query time from the underlying cumulative or delta value). * `.` multiplication or composition (as an infix operator). For examples, `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a comment if it follows a `UNIT`. If the annotation is used alone, then the unit is equivalent to `1`. For examples, `{request}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing `{` or `}`. * `1` represents a unitary [dimensionless unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in `1/s`. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a metric value of `5.3` would mean "5300 page views per day"). * `%` represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value `3` means "3 percent"). * `10^2.%` indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value `0.03` means "3 percent"). */ unit?: string | null; /** diff --git a/src/apis/serviceusage/v1beta1.ts b/src/apis/serviceusage/v1beta1.ts index 30246b6afea..01bb2ae3561 100644 --- a/src/apis/serviceusage/v1beta1.ts +++ b/src/apis/serviceusage/v1beta1.ts @@ -244,7 +244,11 @@ export namespace serviceusage_v1beta1 { */ deadline?: number | null; /** - * The JWT audience is used when generating a JWT id token for the backend. + * When disable_auth is false, a JWT ID token will be generated with the value from BackendRule.address as jwt_audience, overrode to the HTTP "Authorization" request header and sent to the backend. When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header. + */ + disableAuth?: boolean | null; + /** + * The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend. */ jwtAudience?: string | null; /** @@ -1047,7 +1051,7 @@ export namespace serviceusage_v1beta1 { */ type?: string | null; /** - * The unit in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The supported units are a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day **Prefixes (PREFIX)** * `k` kilo (10**3) * `M` mega (10**6) * `G` giga (10**9) * `T` tera (10**12) * `P` peta (10**15) * `E` exa (10**18) * `Z` zetta (10**21) * `Y` yotta (10**24) * `m` milli (10**-3) * `u` micro (10**-6) * `n` nano (10**-9) * `p` pico (10**-12) * `f` femto (10**-15) * `a` atto (10**-18) * `z` zepto (10**-21) * `y` yocto (10**-24) * `Ki` kibi (2**10) * `Mi` mebi (2**20) * `Gi` gibi (2**30) * `Ti` tebi (2**40) **Grammar** The grammar also includes these connectors: * `/` division (as an infix operator, e.g. `1/s`). * `.` multiplication (as an infix operator, e.g. `GBy.d`) The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a comment if it follows a `UNIT` and is equivalent to `1` if it is used alone. For examples, `{requests}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing '{' or '}'. * `1` represents dimensionless value 1, such as in `1/s`. * `%` represents dimensionless value 1/100, and annotates values giving a percentage. + * The units in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the representation of the stored metric values. Different systems may scale the values to be more easily displayed (so a value of `0.02KBy` _might_ be displayed as `20By`, and a value of `3523KBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is `KBy`, then the value of the metric is always in thousands of bytes, no matter how it may be displayed.. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just `s`). If the job uses 12,005 CPU-seconds, then the value is written as `12005`. Alternatively, if you want a custom metric to record data in a more granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is `ks{CPU}`, and then write the value `12.005` (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which is `12005/1024`). The supported units are a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For examples, `kBy/{email}` or `MiBy/10ms` (although you should almost never have `/s` in a metric `unit`; rates should always be computed at query time from the underlying cumulative or delta value). * `.` multiplication or composition (as an infix operator). For examples, `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a comment if it follows a `UNIT`. If the annotation is used alone, then the unit is equivalent to `1`. For examples, `{request}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing `{` or `}`. * `1` represents a unitary [dimensionless unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in `1/s`. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a metric value of `5.3` would mean "5300 page views per day"). * `%` represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value `3` means "3 percent"). * `10^2.%` indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value `0.03` means "3 percent"). */ unit?: string | null; /** diff --git a/src/apis/sheets/v4.ts b/src/apis/sheets/v4.ts index 380fc8fe95a..8986521d196 100644 --- a/src/apis/sheets/v4.ts +++ b/src/apis/sheets/v4.ts @@ -1229,6 +1229,19 @@ export namespace sheets_v4 { */ red?: number | null; } + /** + * A color value. + */ + export interface Schema$ColorStyle { + /** + * RGB color. + */ + rgbColor?: Schema$Color; + /** + * Theme color. + */ + themeColor?: string | null; + } /** * A rule describing a conditional format. */ @@ -3301,6 +3314,10 @@ export namespace sheets_v4 { * The locale of the spreadsheet in one of the following formats: * an ISO 639-1 language code such as `en` * an ISO 639-2 language code such as `fil`, if no 639-1 code exists * a combination of the ISO language code and country code, such as `en_US` Note: when updating this field, not all locales/languages are supported. */ locale?: string | null; + /** + * Theme applied to the spreadsheet. + */ + spreadsheetTheme?: Schema$SpreadsheetTheme; /** * The time zone of the spreadsheet, in CLDR format such as `America/New_York`. If the time zone isn't recognized, this may be a custom time zone such as `GMT-07:00`. */ @@ -3310,6 +3327,19 @@ export namespace sheets_v4 { */ title?: string | null; } + /** + * Represents spreadsheet theme + */ + export interface Schema$SpreadsheetTheme { + /** + * / Name of the primary font family. + */ + primaryFontFamily?: string | null; + /** + * The spreadsheet theme color pairs. For update users need to give all pairs of theme colors. + */ + themeColors?: Schema$ThemeColorPair[]; + } /** * The format of a run of text in a cell. Absent values indicate that the field isn't specified. */ @@ -3395,6 +3425,19 @@ export namespace sheets_v4 { */ source?: Schema$GridRange; } + /** + * A pair mapping a spreadsheet theme color type to the concrete color it represents. + */ + export interface Schema$ThemeColorPair { + /** + * The concrete color corresponding to the theme color type. + */ + color?: Schema$ColorStyle; + /** + * The type of the spreadsheet theme color. + */ + colorType?: string | null; + } /** * A color scale for a treemap chart. */ @@ -3753,7 +3796,7 @@ export namespace sheets_v4 { properties?: Schema$SheetProperties; } /** - * Updates a slicer’s specifications. (This does not move or resize a slicer. To move or resize a slicer use UpdateEmbeddedObjectPositionRequest. + * Updates a slicer's specifications. (This does not move or resize a slicer. To move or resize a slicer use UpdateEmbeddedObjectPositionRequest. */ export interface Schema$UpdateSlicerSpecRequest { /** diff --git a/src/apis/sourcerepo/v1.ts b/src/apis/sourcerepo/v1.ts index 932bd5f1d8e..0d1df782bb0 100644 --- a/src/apis/sourcerepo/v1.ts +++ b/src/apis/sourcerepo/v1.ts @@ -116,7 +116,7 @@ export namespace sourcerepo_v1 { } /** - * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -129,7 +129,7 @@ export namespace sourcerepo_v1 { service?: string | null; } /** - * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. */ export interface Schema$AuditLogConfig { /** @@ -150,7 +150,7 @@ export namespace sourcerepo_v1 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -239,7 +239,7 @@ export namespace sourcerepo_v1 { response?: {[key: string]: any} | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -247,15 +247,15 @@ export namespace sourcerepo_v1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Deprecated. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } @@ -824,6 +824,7 @@ export namespace sourcerepo_v1 { * @memberOf! () * * @param {object} params Parameters for request + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1308,6 +1309,10 @@ export namespace sourcerepo_v1 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + */ + 'options.requestedPolicyVersion'?: number; /** * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ diff --git a/src/apis/spanner/v1.ts b/src/apis/spanner/v1.ts index 39d2407e287..eeb07c47a2b 100644 --- a/src/apis/spanner/v1.ts +++ b/src/apis/spanner/v1.ts @@ -155,7 +155,7 @@ export namespace spanner_v1 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -306,15 +306,15 @@ export namespace spanner_v1 { */ export interface Schema$ExecuteBatchDmlRequest { /** - * A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one will succeed. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction may be aborted. Replays of previously handled requests will yield the same response as the first execution. + * Required. A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one will succeed. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction may be aborted. Replays of previously handled requests will yield the same response as the first execution. */ seqno?: string | null; /** - * The list of statements to execute in this batch. Statements are executed serially, such that the effects of statement `i` are visible to statement `i+1`. Each statement must be a DML statement. Execution stops at the first failed statement; the remaining statements are not executed. Callers must provide at least one statement. + * Required. The list of statements to execute in this batch. Statements are executed serially, such that the effects of statement `i` are visible to statement `i+1`. Each statement must be a DML statement. Execution stops at the first failed statement; the remaining statements are not executed. Callers must provide at least one statement. */ statements?: Schema$Statement[]; /** - * The transaction to use. Must be a read-write transaction. To protect against replays, single-use transactions are not supported. The caller must either supply an existing transaction ID or begin a new transaction. + * Required. The transaction to use. Must be a read-write transaction. To protect against replays, single-use transactions are not supported. The caller must either supply an existing transaction ID or begin a new transaction. */ transaction?: Schema$TransactionSelector; } @@ -441,6 +441,10 @@ export namespace spanner_v1 { * Required. The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length. */ displayName?: string | null; + /** + * Output only. A set of endpoint URIs based on your instance config that you can use instead of the global endpoint `spanner.googleapis.com`. For example, if your instance config is `us-central1` (a regional config in Iowa), then your instance specific endpoints may include `us-central1-spanner.googleapis.com`. By calling these endpoints instead of the global endpoint, you optimize network routing which could reduce network latency. The client libraries, JDBC drivers, and other SDK clients automatically call these instance specific endpoints. If you are using DNS whitelists, firewalls, or filtering to control access to endpoints, make sure you grant access to `*spanner.googleapis.com`. + */ + endpointUris?: string[] | null; /** * Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.). * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. * No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. And so you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "_" + value would prove problematic if we were to allow "_" in a future release. */ @@ -450,7 +454,7 @@ export namespace spanner_v1 { */ name?: string | null; /** - * Required. The number of nodes allocated to this instance. This may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/instances#node_count) for more information about nodes. + * The number of nodes allocated to this instance. This may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/instances#node_count) for more information about nodes. */ nodeCount?: number | null; /** @@ -591,7 +595,7 @@ export namespace spanner_v1 { */ insert?: Schema$Write; /** - * Like insert, except that if the row already exists, then its column values are overwritten with the ones provided. Any column values not explicitly written are preserved. + * Like insert, except that if the row already exists, then its column values are overwritten with the ones provided. Any column values not explicitly written are preserved. When using insert_or_update, just as when using insert, all `NOT NULL` columns in the table must be given a value. This holds true even when the row already exists and will therefore actually be updated. */ insertOrUpdate?: Schema$Write; /** @@ -696,7 +700,7 @@ export namespace spanner_v1 { */ partitionOptions?: Schema$PartitionOptions; /** - * The query request to generate partitions for. The request will fail if the query is not root partitionable. The query plan of a root partitionable query has a single distributed union operator. A distributed union operator conceptually divides one or more tables into multiple splits, remotely evaluates a subquery independently on each split, and then unions all results. This must not contain DML commands, such as INSERT, UPDATE, or DELETE. Use ExecuteStreamingSql with a PartitionedDml transaction for large, partition-friendly DML operations. + * Required. The query request to generate partitions for. The request will fail if the query is not root partitionable. The query plan of a root partitionable query has a single distributed union operator. A distributed union operator conceptually divides one or more tables into multiple splits, remotely evaluates a subquery independently on each split, and then unions all results. This must not contain DML commands, such as INSERT, UPDATE, or DELETE. Use ExecuteStreamingSql with a PartitionedDml transaction for large, partition-friendly DML operations. */ sql?: string | null; /** @@ -780,19 +784,19 @@ export namespace spanner_v1 { shortRepresentation?: Schema$ShortRepresentation; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if either of incoming or stored policy does not meet the version requirements. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a conditional binding from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, any version compliance checks on the incoming and/or stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } @@ -839,7 +843,7 @@ export namespace spanner_v1 { */ export interface Schema$ReadRequest { /** - * The columns of table to be returned for each row matching this request. + * Required. The columns of table to be returned for each row matching this request. */ columns?: string[] | null; /** @@ -1143,7 +1147,7 @@ export namespace spanner_v1 { */ operationId?: string | null; /** - * DDL statements to be applied to the database. + * Required. DDL statements to be applied to the database. */ statements?: string[] | null; } @@ -1173,11 +1177,11 @@ export namespace spanner_v1 { */ export interface Schema$UpdateInstanceRequest { /** - * Required. A mask specifying which fields in [][google.spanner.admin.instance.v1.UpdateInstanceRequest.instance] should be updated. The field mask must always be specified; this prevents any future fields in [][google.spanner.admin.instance.v1.Instance] from being erased accidentally by clients that do not know about them. + * Required. A mask specifying which fields in Instance should be updated. The field mask must always be specified; this prevents any future fields in Instance from being erased accidentally by clients that do not know about them. */ fieldMask?: string | null; /** - * Required. The instance to update, which must always include the instance name. Otherwise, only fields mentioned in [][google.spanner.admin.instance.v1.UpdateInstanceRequest.field_mask] need be included. + * Required. The instance to update, which must always include the instance name. Otherwise, only fields mentioned in field_mask need be included. */ instance?: Schema$Instance; } @@ -1408,10 +1412,12 @@ export namespace spanner_v1 { export class Resource$Projects$Instances { context: APIRequestContext; + backups: Resource$Projects$Instances$Backups; databases: Resource$Projects$Instances$Databases; operations: Resource$Projects$Instances$Operations; constructor(context: APIRequestContext) { this.context = context; + this.backups = new Resource$Projects$Instances$Backups(this.context); this.databases = new Resource$Projects$Instances$Databases(this.context); this.operations = new Resource$Projects$Instances$Operations( this.context @@ -1569,6 +1575,7 @@ export namespace spanner_v1 { * @memberOf! () * * @param {object} params Parameters for request + * @param {string=} params.fieldMask If field_mask is present, specifies the subset of Instance fields that should be returned. If absent, all Instance fields are returned. * @param {string} params.name Required. The name of the requested instance. Values are of the form `projects//instances/`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2047,6 +2054,10 @@ export namespace spanner_v1 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * If field_mask is present, specifies the subset of Instance fields that should be returned. If absent, all Instance fields are returned. + */ + fieldMask?: string; /** * Required. The name of the requested instance. Values are of the form `projects//instances/`. */ @@ -2145,6 +2156,650 @@ export namespace spanner_v1 { requestBody?: Schema$TestIamPermissionsRequest; } + export class Resource$Projects$Instances$Backups { + context: APIRequestContext; + operations: Resource$Projects$Instances$Backups$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Projects$Instances$Backups$Operations( + this.context + ); + } + + /** + * spanner.projects.instances.backups.getIamPolicy + * @desc Gets the access control policy for a database resource. Returns an empty policy if a database exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource. + * @alias spanner.projects.instances.backups.getIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources. + * @param {().GetIamPolicyRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIamPolicy( + params?: Params$Resource$Projects$Instances$Backups$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Instances$Backups$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Instances$Backups$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Backups$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Backups$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Instances$Backups$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://spanner.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * spanner.projects.instances.backups.setIamPolicy + * @desc Sets the access control policy on a database resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. + * @alias spanner.projects.instances.backups.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for databases resources. + * @param {().SetIamPolicyRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setIamPolicy( + params?: Params$Resource$Projects$Instances$Backups$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Instances$Backups$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Instances$Backups$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Backups$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Backups$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Instances$Backups$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://spanner.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * spanner.projects.instances.backups.testIamPermissions + * @desc Returns permissions that the caller has on the specified database resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. + * @alias spanner.projects.instances.backups.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources. + * @param {().TestIamPermissionsRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Projects$Instances$Backups$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Instances$Backups$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Instances$Backups$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Backups$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Backups$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Instances$Backups$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://spanner.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Instances$Backups$Getiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GetIamPolicyRequest; + } + export interface Params$Resource$Projects$Instances$Backups$Setiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for databases resources. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Instances$Backups$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + + export class Resource$Projects$Instances$Backups$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * spanner.projects.instances.backups.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 spanner.projects.instances.backups.operations.cancel + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the operation resource to be cancelled. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + cancel( + params?: Params$Resource$Projects$Instances$Backups$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Instances$Backups$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Instances$Backups$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Backups$Operations$Cancel + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Backups$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Instances$Backups$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://spanner.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * spanner.projects.instances.backups.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 spanner.projects.instances.backups.operations.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the operation resource to be deleted. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Projects$Instances$Backups$Operations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Instances$Backups$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Instances$Backups$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Backups$Operations$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Backups$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Instances$Backups$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://spanner.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * spanner.projects.instances.backups.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 spanner.projects.instances.backups.operations.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the operation resource. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Projects$Instances$Backups$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Instances$Backups$Operations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Instances$Backups$Operations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Backups$Operations$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Backups$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Instances$Backups$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://spanner.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * spanner.projects.instances.backups.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 spanner.projects.instances.backups.operations.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter The standard list filter. + * @param {string} params.name The name of the operation's parent resource. + * @param {integer=} params.pageSize The standard list page size. + * @param {string=} params.pageToken The standard list page token. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$Instances$Backups$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Instances$Backups$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Instances$Backups$Operations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Backups$Operations$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Backups$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Instances$Backups$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://spanner.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Instances$Backups$Operations$Cancel + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Instances$Backups$Operations$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Instances$Backups$Operations$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Instances$Backups$Operations$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + export class Resource$Projects$Instances$Databases { context: APIRequestContext; operations: Resource$Projects$Instances$Databases$Operations; diff --git a/src/apis/speech/v1.ts b/src/apis/speech/v1.ts index cea6d5ced3a..cb1218efdca 100644 --- a/src/apis/speech/v1.ts +++ b/src/apis/speech/v1.ts @@ -290,10 +290,6 @@ export namespace speech_v1 { * The audio type that most closely describes the audio being recognized. */ microphoneDistance?: string | null; - /** - * Obfuscated (privacy-protected) ID of the user, to identify number of unique users using the service. - */ - obfuscatedId?: string | null; /** * The original media the speech was recorded on. */ @@ -349,6 +345,10 @@ export namespace speech_v1 { * Minimum number of speakers in the conversation. This range gives you more flexibility by allowing the system to automatically determine the correct number of speakers. If not set, the default value is 2. */ minSpeakerCount?: number | null; + /** + * Output only. Unused. + */ + speakerTag?: number | null; } /** * Provides "hints" to the speech recognizer to favor specific words and phrases in the results. @@ -415,7 +415,7 @@ export namespace speech_v1 { */ endTime?: string | null; /** - * A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from '1' to diarization_speaker_count. speaker_tag is set if enable_speaker_diarization = 'true' and only in the top alternative. + * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from '1' to diarization_speaker_count. speaker_tag is set if enable_speaker_diarization = 'true' and only in the top alternative. */ speakerTag?: number | null; /** diff --git a/src/apis/speech/v1p1beta1.ts b/src/apis/speech/v1p1beta1.ts index c70324c83da..0d88e9c22e3 100644 --- a/src/apis/speech/v1p1beta1.ts +++ b/src/apis/speech/v1p1beta1.ts @@ -339,10 +339,6 @@ export namespace speech_v1p1beta1 { * Required. Provides information to the recognizer that specifies how to process the request. */ config?: Schema$RecognitionConfig; - /** - * Use `model` field in RecognitionConfig instead. - */ - name?: string | null; } /** * The only message returned to the client by the `Recognize` method. It contains the result as zero or more sequential `SpeechRecognitionResult` messages. @@ -369,6 +365,10 @@ export namespace speech_v1p1beta1 { * Minimum number of speakers in the conversation. This range gives you more flexibility by allowing the system to automatically determine the correct number of speakers. If not set, the default value is 2. */ minSpeakerCount?: number | null; + /** + * Output only. Unused. + */ + speakerTag?: number | null; } /** * Provides "hints" to the speech recognizer to favor specific words and phrases in the results. @@ -413,7 +413,7 @@ export namespace speech_v1p1beta1 { */ channelTag?: number | null; /** - * The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio. + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio. */ languageCode?: string | null; } @@ -447,7 +447,7 @@ export namespace speech_v1p1beta1 { */ endTime?: string | null; /** - * A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from '1' to diarization_speaker_count. speaker_tag is set if enable_speaker_diarization = 'true' and only in the top alternative. + * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from '1' to diarization_speaker_count. speaker_tag is set if enable_speaker_diarization = 'true' and only in the top alternative. */ speakerTag?: number | null; /** diff --git a/src/apis/sql/v1beta4.ts b/src/apis/sql/v1beta4.ts index a71b10b79ed..2075c6257da 100644 --- a/src/apis/sql/v1beta4.ts +++ b/src/apis/sql/v1beta4.ts @@ -108,6 +108,7 @@ export namespace sql_v1beta4 { flags: Resource$Flags; instances: Resource$Instances; operations: Resource$Operations; + projects: Resource$Projects; sslCerts: Resource$Sslcerts; tiers: Resource$Tiers; users: Resource$Users; @@ -123,6 +124,7 @@ export namespace sql_v1beta4 { this.flags = new Resource$Flags(this.context); this.instances = new Resource$Instances(this.context); this.operations = new Resource$Operations(this.context); + this.projects = new Resource$Projects(this.context); this.sslCerts = new Resource$Sslcerts(this.context); this.tiers = new Resource$Tiers(this.context); this.users = new Resource$Users(this.context); @@ -142,7 +144,7 @@ export namespace sql_v1beta4 { */ kind?: string | null; /** - * An optional label to identify this entry. + * Optional. A label to identify this entry. */ name?: string | null; /** @@ -364,7 +366,7 @@ export namespace sql_v1beta4 { value?: string | null; } /** - * A Cloud SQL instance resource. If you change this, also change SqlDatabaseInstance + * A Cloud SQL instance resource. */ export interface Schema$DatabaseInstance { /** @@ -610,9 +612,9 @@ export namespace sql_v1beta4 { * Options for exporting data as SQL statements. */ sqlExportOptions?: { - schemaOnly?: boolean; mysqlExportOptions?: {masterData?: number}; tables?: string[]; + schemaOnly?: boolean; } | null; /** * The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form <code>gs: //bucketName/fileName</code>. If the file already exists, the requests // succeeds, but the operation fails. If <code>fileType</code> is // <code>SQL</code> and the filename ends with .gz, the contents are // compressed. @@ -703,7 +705,7 @@ export namespace sql_v1beta4 { /** * Options for importing data as CSV. */ - csvImportOptions?: {table?: string; columns?: string[]} | null; + csvImportOptions?: {columns?: string[]; table?: string} | null; /** * The target database for the import. If <code>fileType</code> is <code>SQL</code>, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If <code>fileType</code> is <code>CSV</code>, one database must be specified. */ @@ -961,6 +963,18 @@ export namespace sql_v1beta4 { * On-premises instance configuration. */ export interface Schema$OnPremisesConfiguration { + /** + * PEM representation of the trusted CA's x509 certificate. + */ + caCertificate?: string | null; + /** + * PEM representation of the slave's x509 certificate. + */ + clientCertificate?: string | null; + /** + * PEM representation of the slave's private key. The corresponsing public key is encoded in the client's certificate. + */ + clientKey?: string | null; /** * The host and port of the on-premises instance in host:port format */ @@ -1015,7 +1029,7 @@ export namespace sql_v1beta4 { */ startTime?: string | null; /** - * The status of an operation. Valid values are <code>PENDING</code>, <code>RUNNING</code>, <code>DONE</code>, <code>UNKNOWN</code>. + * The status of an operation. Valid values are <code>PENDING</code>, <code>RUNNING</code>, <code>DONE</code>, <code>SQL_OPERATION_STATUS_UNSPECIFIED</code>. */ status?: string | null; /** @@ -1096,6 +1110,16 @@ export namespace sql_v1beta4 { */ mysqlReplicaConfiguration?: Schema$MySqlReplicaConfiguration; } + export interface Schema$Reschedule { + /** + * Required. The type of the reschedule. + */ + rescheduleType?: string | null; + /** + * Optional. Timestamp when the maintenance shall be rescheduled to if reschedule_type=SPECIFIC_TIME. + */ + scheduleTime?: string | null; + } /** * Database instance restore from backup context. Backup context contains source instance id and project id. */ @@ -1215,14 +1239,24 @@ export namespace sql_v1beta4 { */ userLabels?: {[key: string]: string} | null; } + /** + * Reschedule options for maintenance windows. + */ + export interface Schema$SqlInstancesRescheduleMaintenanceRequestBody { + /** + * Required. The type of the reschedule the user wants. + */ + reschedule?: Schema$Reschedule; + } /** * Any scheduled maintenancce for this instance. */ export interface Schema$SqlScheduledMaintenance { + canDefer?: boolean | null; /** - * If the scheduled maintenance can be deferred. + * If the scheduled maintenance can be rescheduled. */ - canDefer?: boolean | null; + canReschedule?: boolean | null; /** * The start time of any upcoming scheduled maintenance for this instance. */ @@ -3252,7 +3286,7 @@ export namespace sql_v1beta4 { /** * sql.instances.list - * @desc Lists instances under a given project in the alphabetical order of the instance name. + * @desc Lists instances under a given project. * @alias sql.instances.list * @memberOf! () * @@ -4656,6 +4690,7 @@ export namespace sql_v1beta4 { * @param {object} params Parameters for request * @param {string} params.operation Instance operation ID. * @param {string} params.project Project ID of the project that contains the instance. + * @param {string=} params.resourceName The name of the operation for Cloud SQL to get. Format: projects/{project}/locations/{location}/operations/{operation} * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4813,6 +4848,10 @@ export namespace sql_v1beta4 { * Project ID of the project that contains the instance. */ project?: string; + /** + * The name of the operation for Cloud SQL to get. Format: projects/{project}/locations/{location}/operations/{operation} + */ + resourceName?: string; } export interface Params$Resource$Operations$List extends StandardParameters { /** @@ -4842,6 +4881,249 @@ export namespace sql_v1beta4 { project?: string; } + export class Resource$Projects { + context: APIRequestContext; + instances: Resource$Projects$Instances; + locations: Resource$Projects$Locations; + constructor(context: APIRequestContext) { + this.context = context; + this.instances = new Resource$Projects$Instances(this.context); + this.locations = new Resource$Projects$Locations(this.context); + } + } + + export class Resource$Projects$Instances { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * sql.projects.instances.rescheduleMaintenance + * @desc Reschedules the maintenance on the given instance. + * @alias sql.projects.instances.rescheduleMaintenance + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Cloud SQL instance ID. This does not include the project ID. + * @param {string=} params.parent The parent resource where Cloud SQL reshedule this database instance's maintenance. Format: projects/{project}/locations/{location}/instances/{instance} + * @param {string} params.project ID of the project that contains the instance. + * @param {().SqlInstancesRescheduleMaintenanceRequestBody} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + rescheduleMaintenance( + params?: Params$Resource$Projects$Instances$Reschedulemaintenance, + options?: MethodOptions + ): GaxiosPromise; + rescheduleMaintenance( + params: Params$Resource$Projects$Instances$Reschedulemaintenance, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + rescheduleMaintenance( + params: Params$Resource$Projects$Instances$Reschedulemaintenance, + callback: BodyResponseCallback + ): void; + rescheduleMaintenance( + callback: BodyResponseCallback + ): void; + rescheduleMaintenance( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Reschedulemaintenance + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Reschedulemaintenance; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Instances$Reschedulemaintenance; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/sql/v1beta4/projects/{project}/instances/{instance}/rescheduleMaintenance' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'instance'], + pathParams: ['instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Instances$Reschedulemaintenance + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Cloud SQL instance ID. This does not include the project ID. + */ + instance?: string; + /** + * The parent resource where Cloud SQL reshedule this database instance's maintenance. Format: projects/{project}/locations/{location}/instances/{instance} + */ + parent?: string; + /** + * ID of the project that contains the instance. + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SqlInstancesRescheduleMaintenanceRequestBody; + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + instances: Resource$Projects$Locations$Instances; + constructor(context: APIRequestContext) { + this.context = context; + this.instances = new Resource$Projects$Locations$Instances(this.context); + } + } + + export class Resource$Projects$Locations$Instances { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * sql.projects.locations.instances.rescheduleMaintenance + * @desc Reschedules the maintenance on the given instance. + * @alias sql.projects.locations.instances.rescheduleMaintenance + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.instance Cloud SQL instance ID. This does not include the project ID. + * @param {string} params.parent The parent resource where Cloud SQL reshedule this database instance's maintenance. Format: projects/{project}/locations/{location}/instances/{instance} + * @param {string=} params.project ID of the project that contains the instance. + * @param {().SqlInstancesRescheduleMaintenanceRequestBody} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + rescheduleMaintenance( + params?: Params$Resource$Projects$Locations$Instances$Reschedulemaintenance, + options?: MethodOptions + ): GaxiosPromise; + rescheduleMaintenance( + params: Params$Resource$Projects$Locations$Instances$Reschedulemaintenance, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + rescheduleMaintenance( + params: Params$Resource$Projects$Locations$Instances$Reschedulemaintenance, + callback: BodyResponseCallback + ): void; + rescheduleMaintenance( + callback: BodyResponseCallback + ): void; + rescheduleMaintenance( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Instances$Reschedulemaintenance + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Instances$Reschedulemaintenance; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Instances$Reschedulemaintenance; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/sql/v1beta4/{+parent}/rescheduleMaintenance' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Instances$Reschedulemaintenance + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Cloud SQL instance ID. This does not include the project ID. + */ + instance?: string; + /** + * The parent resource where Cloud SQL reshedule this database instance's maintenance. Format: projects/{project}/locations/{location}/instances/{instance} + */ + parent?: string; + /** + * ID of the project that contains the instance. + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SqlInstancesRescheduleMaintenanceRequestBody; + } + export class Resource$Sslcerts { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -5677,7 +5959,7 @@ export namespace sql_v1beta4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.host Host of the user in the instance. For a MySQL instance, it's required; For a PostgreSQL instance, it's optional. + * @param {string=} params.host Optional. Host of the user in the instance. * @param {string} params.instance Database instance ID. This does not include the project ID. * @param {string=} params.name Name of the user in the instance. * @param {string} params.project Project ID of the project that contains the instance. @@ -5826,7 +6108,7 @@ export namespace sql_v1beta4 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Host of the user in the instance. For a MySQL instance, it's required; For a PostgreSQL instance, it's optional. + * Optional. Host of the user in the instance. */ host?: string; /** diff --git a/src/apis/storage/v1.ts b/src/apis/storage/v1.ts index a96792c6930..16ec8296d04 100644 --- a/src/apis/storage/v1.ts +++ b/src/apis/storage/v1.ts @@ -232,7 +232,7 @@ export namespace storage_v1 { */ selfLink?: string | null; /** - * The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes. + * The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes. */ storageClass?: string | null; /** diff --git a/src/apis/storagetransfer/v1.ts b/src/apis/storagetransfer/v1.ts index 3a2242c963a..86ea2096349 100644 --- a/src/apis/storagetransfer/v1.ts +++ b/src/apis/storagetransfer/v1.ts @@ -1096,7 +1096,7 @@ export namespace storagetransfer_v1 { /** * storagetransfer.transferJobs.patch - * @desc Updates a transfer job. Updating a job's transfer spec does not affect transfer operations that are running already. Updating the scheduling of a job is not allowed. + * @desc Updates a transfer job. Updating a job's transfer spec does not affect transfer operations that are running already. Updating a job's schedule is not allowed. Note: The job's `status` field can be modified using this RPC (for example, to set a job's status to `DELETED`, `DISABLED`, or `ENABLED`). * @example * * // BEFORE RUNNING: * // --------------- diff --git a/src/apis/streetviewpublish/v1.ts b/src/apis/streetviewpublish/v1.ts index cba71cb0ab8..19799d66227 100644 --- a/src/apis/streetviewpublish/v1.ts +++ b/src/apis/streetviewpublish/v1.ts @@ -256,7 +256,7 @@ export namespace streetviewpublish_v1 { */ downloadUrl?: string | null; /** - * Output only. Status in Google Maps, whether this photo was published or rejected. + * Output only. Status in Google Maps, whether this photo was published or rejected. Not currently populated. */ mapsPublishStatus?: string | null; /** diff --git a/src/apis/surveys/v2.ts b/src/apis/surveys/v2.ts deleted file mode 100644 index 73121a5fc76..00000000000 --- a/src/apis/surveys/v2.ts +++ /dev/null @@ -1,1089 +0,0 @@ -// Copyright 2019 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -import { - OAuth2Client, - JWT, - Compute, - UserRefreshClient, -} from 'google-auth-library'; -import { - GoogleConfigurable, - createAPIRequest, - MethodOptions, - GlobalOptions, - BodyResponseCallback, - APIRequestContext, -} from 'googleapis-common'; -import {GaxiosPromise} from 'gaxios'; - -// tslint:disable: no-any -// tslint:disable: class-name -// tslint:disable: variable-name -// tslint:disable: jsdoc-format -// tslint:disable: no-namespace - -export namespace surveys_v2 { - export interface Options extends GlobalOptions { - version: 'v2'; - } - - interface StandardParameters { - /** - * Data format for the response. - */ - alt?: string; - /** - * Selector specifying which fields to include in a partial response. - */ - fields?: string; - /** - * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - */ - key?: string; - /** - * OAuth 2.0 token for the current user. - */ - oauth_token?: string; - /** - * Returns response with indentations and line breaks. - */ - prettyPrint?: boolean; - /** - * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - */ - quotaUser?: string; - /** - * Deprecated. Please use quotaUser instead. - */ - userIp?: string; - } - - /** - * Surveys API - * - * Creates and conducts surveys, lists the surveys that an authenticated user owns, and retrieves survey results and information about specified surveys. - * - * @example - * const {google} = require('googleapis'); - * const surveys = google.surveys('v2'); - * - * @namespace surveys - * @type {Function} - * @version v2 - * @variation v2 - * @param {object=} options Options for Surveys - */ - export class Surveys { - context: APIRequestContext; - results: Resource$Results; - surveys: Resource$Surveys; - - constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = { - _options: options || {}, - google, - }; - - this.results = new Resource$Results(this.context); - this.surveys = new Resource$Surveys(this.context); - } - } - - export interface Schema$FieldMask { - fields?: Schema$FieldMask[]; - id?: number | null; - } - export interface Schema$PageInfo { - resultPerPage?: number | null; - startIndex?: number | null; - totalResults?: number | null; - } - export interface Schema$ResultsGetRequest { - resultMask?: Schema$ResultsMask; - } - export interface Schema$ResultsMask { - fields?: Schema$FieldMask[]; - projection?: string | null; - } - /** - * Representation of an individual survey object. - */ - export interface Schema$Survey { - /** - * Targeting-criteria message containing demographic information - */ - audience?: Schema$SurveyAudience; - /** - * Cost to run the survey and collect the necessary number of responses. - */ - cost?: Schema$SurveyCost; - /** - * Additional information to store on behalf of the API consumer and associate with this question. This binary blob is treated as opaque. This field is limited to 64K bytes. - */ - customerData?: string | null; - /** - * Text description of the survey. - */ - description?: string | null; - /** - * List of email addresses for survey owners. Must contain at least the address of the user making the API call. - */ - owners?: string[] | null; - /** - * List of questions defining the survey. - */ - questions?: Schema$SurveyQuestion[]; - /** - * Reason for the survey being rejected. Only present if the survey state is rejected. - */ - rejectionReason?: Schema$SurveyRejection; - /** - * State that the survey is in. - */ - state?: string | null; - /** - * Unique survey ID, that is viewable in the URL of the Survey Creator UI - */ - surveyUrlId?: string | null; - /** - * Optional name that will be given to the survey. - */ - title?: string | null; - /** - * Number of responses desired for the survey. - */ - wantedResponseCount?: number | null; - } - /** - * Specifications for the target audience of a survey run through the API. - */ - export interface Schema$SurveyAudience { - /** - * Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+'] - */ - ages?: string[] | null; - /** - * Required country code that surveys should be targeted to. Accepts standard ISO 3166-1 2 character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom. - */ - country?: string | null; - /** - * Country subdivision (states/provinces/etc) that surveys should be targeted to. For all countries except GB, ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 statistical region codes for the United Kingdom is required (eg. 'UK-UKC' for North East England). - */ - countrySubdivision?: string | null; - /** - * Optional gender to target. - */ - gender?: string | null; - /** - * Language code that surveys should be targeted to. For instance, 'en-US'. Surveys may target bilingual users by specifying a list of language codes (for example, 'de' and 'en-US'). In that case, all languages will be used for targeting users but the survey content (which is displayed) must match the first language listed. Accepts standard BCP47 language codes. See specification. - */ - languages?: string[] | null; - /** - * Online population source where the respondents are sampled from. - */ - populationSource?: string | null; - } - /** - * Message defining the cost to run a given survey through API. - */ - export interface Schema$SurveyCost { - /** - * Cost per survey response in nano units of the given currency. To get the total cost for a survey, multiply this value by wanted_response_count. - */ - costPerResponseNanos?: string | null; - /** - * Currency code that the cost is given in. - */ - currencyCode?: string | null; - /** - * *Deprecated* Threshold to start a survey automatically if the quoted price is at most this value. When a survey has a Screener (threshold) question, it must go through an incidence pricing test to determine the final cost per response. Typically you will have to make a followup call to start the survey giving the final computed cost per response. If the survey has no threshold_answers, setting this property will return an error. By specifying this property, you indicate the max price per response you are willing to pay in advance of the incidence test. If the price turns out to be lower than the specified value, the survey will begin immediately and you will be charged at the rate determined by the incidence pricing test. If the price turns out to be greater than the specified value the survey will not be started and you will instead be notified what price was determined by the incidence test. At that point, you must raise the value of this property to be greater than or equal to that cost before attempting to start the survey again. This will immediately start the survey as long the incidence test was run within the last 21 days. This will no longer be available after June 2018. - */ - maxCostPerResponseNanos?: string | null; - /** - * Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos - */ - nanos?: string | null; - } - /** - * Message defining the question specifications. - */ - export interface Schema$SurveyQuestion { - /** - * The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize. - */ - answerOrder?: string | null; - /** - * Required list of answer options for a question. - */ - answers?: string[] | null; - /** - * Option to allow open-ended text box for Single Answer and Multiple Answer question types. This can be used with SINGLE_ANSWER, SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and MULTIPLE_ANSWERS_WITH_IMAGE question types. - */ - hasOther?: boolean | null; - /** - * For rating questions, the text for the higher end of the scale, such as 'Best'. For numeric questions, a string representing a floating-point that is the maximum allowed number for a response. - */ - highValueLabel?: string | null; - images?: Schema$SurveyQuestionImage[]; - /** - * Currently only support pinning an answer option to the last position. - */ - lastAnswerPositionPinned?: boolean | null; - /** - * For rating questions, the text for the lower end of the scale, such as 'Worst'. For numeric questions, a string representing a floating-point that is the minimum allowed number for a response. - */ - lowValueLabel?: string | null; - /** - * Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question. - */ - mustPickSuggestion?: boolean | null; - /** - * Number of stars to use for ratings questions. - */ - numStars?: string | null; - /** - * Placeholder text for an open text question. - */ - openTextPlaceholder?: string | null; - /** - * A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true. - */ - openTextSuggestions?: string[] | null; - /** - * Required question text shown to the respondent. - */ - question?: string | null; - /** - * Used by the Rating Scale with Text question type. This text goes along with the question field that is presented to the respondent, and is the actual text that the respondent is asked to rate. - */ - sentimentText?: string | null; - /** - * Option to allow multiple line open text responses instead of a single line response. Note that we don't show auto-complete suggestions with multiple line responses. - */ - singleLineResponse?: boolean | null; - /** - * The threshold/screener answer options, which will screen a user into the rest of the survey. These will be a subset of the answer option strings. - */ - thresholdAnswers?: string[] | null; - /** - * Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide. - */ - type?: string | null; - /** - * Optional unit of measurement for display (for example: hours, people, miles). - */ - unitOfMeasurementLabel?: string | null; - /** - * The YouTube video ID to be show in video questions. - */ - videoId?: string | null; - } - /** - * Container object for image data and alt_text. - */ - export interface Schema$SurveyQuestionImage { - /** - * The alt text property used in image tags is required for all images. - */ - altText?: string | null; - /** - * Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types. - */ - data?: string | null; - /** - * The read-only URL for the hosted images. - */ - url?: string | null; - } - /** - * Message representing why the survey was rejected from review, if it was. - */ - export interface Schema$SurveyRejection { - /** - * A human-readable explanation of what was wrong with the survey. - */ - explanation?: string | null; - /** - * Which category of rejection this was. See the Google Surveys Help Center for additional details on each category. - */ - type?: string | null; - } - /** - * Reference to the current results for a given survey. - */ - export interface Schema$SurveyResults { - /** - * Human readable string describing the status of the request. - */ - status?: string | null; - /** - * External survey ID as viewable by survey owners in the editor view. - */ - surveyUrlId?: string | null; - } - export interface Schema$SurveysDeleteResponse { - /** - * Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests. - */ - requestId?: string | null; - } - export interface Schema$SurveysListResponse { - pageInfo?: Schema$PageInfo; - /** - * Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests. - */ - requestId?: string | null; - /** - * An individual survey resource. - */ - resources?: Schema$Survey[]; - tokenPagination?: Schema$TokenPagination; - } - export interface Schema$SurveysStartRequest { - /** - * *Deprecated* Threshold to start a survey automatically if the quoted prices is less than or equal to this value. See Survey.Cost for more details. This will no longer be available after June 2018. - */ - maxCostPerResponseNanos?: string | null; - } - export interface Schema$SurveysStartResponse { - /** - * Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests. - */ - requestId?: string | null; - } - export interface Schema$SurveysStopResponse { - /** - * Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests. - */ - requestId?: string | null; - } - export interface Schema$TokenPagination { - nextPageToken?: string | null; - previousPageToken?: string | null; - } - - export class Resource$Results { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * surveys.results.get - * @desc Retrieves any survey results that have been produced so far. Results are formatted as an Excel file. You must add "?alt=media" to the URL as an argument to get results. - * @alias surveys.results.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.surveyUrlId External URL ID for the survey. - * @param {().ResultsGetRequest} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Results$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Results$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Results$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Results$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Results$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Results$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/surveys/v2/surveys/{surveyUrlId}/results' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['surveyUrlId'], - pathParams: ['surveyUrlId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Results$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * External URL ID for the survey. - */ - surveyUrlId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ResultsGetRequest; - } - - export class Resource$Surveys { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * surveys.surveys.delete - * @desc Removes a survey from view in all user GET requests. - * @alias surveys.surveys.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.surveyUrlId External URL ID for the survey. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Surveys$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Surveys$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Surveys$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Surveys$Delete - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Surveys$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Surveys$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/surveys/v2/surveys/{surveyUrlId}').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['surveyUrlId'], - pathParams: ['surveyUrlId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * surveys.surveys.get - * @desc Retrieves information about the specified survey. - * @alias surveys.surveys.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.surveyUrlId External URL ID for the survey. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Surveys$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Surveys$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Surveys$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Surveys$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Surveys$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Surveys$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/surveys/v2/surveys/{surveyUrlId}').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['surveyUrlId'], - pathParams: ['surveyUrlId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * surveys.surveys.insert - * @desc Creates a survey. - * @alias surveys.surveys.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {().Survey} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - insert( - params?: Params$Resource$Surveys$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Surveys$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Surveys$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Surveys$Insert - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Surveys$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Surveys$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/surveys/v2/surveys').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * surveys.surveys.list - * @desc Lists the surveys owned by the authenticated user. - * @alias surveys.surveys.list - * @memberOf! () - * - * @param {object=} params Parameters for request - * @param {integer=} params.maxResults - * @param {integer=} params.startIndex - * @param {string=} params.token - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Surveys$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Surveys$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Surveys$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Surveys$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Surveys$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Surveys$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/surveys/v2/surveys').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * surveys.surveys.start - * @desc Begins running a survey. - * @alias surveys.surveys.start - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.resourceId - * @param {().SurveysStartRequest} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - start( - params?: Params$Resource$Surveys$Start, - options?: MethodOptions - ): GaxiosPromise; - start( - params: Params$Resource$Surveys$Start, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - start( - params: Params$Resource$Surveys$Start, - callback: BodyResponseCallback - ): void; - start(callback: BodyResponseCallback): void; - start( - paramsOrCallback?: - | Params$Resource$Surveys$Start - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Surveys$Start; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Surveys$Start; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/surveys/v2/surveys/{resourceId}/start').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['resourceId'], - pathParams: ['resourceId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * surveys.surveys.stop - * @desc Stops a running survey. - * @alias surveys.surveys.stop - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.resourceId - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - stop( - params?: Params$Resource$Surveys$Stop, - options?: MethodOptions - ): GaxiosPromise; - stop( - params: Params$Resource$Surveys$Stop, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - stop( - params: Params$Resource$Surveys$Stop, - callback: BodyResponseCallback - ): void; - stop(callback: BodyResponseCallback): void; - stop( - paramsOrCallback?: - | Params$Resource$Surveys$Stop - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Surveys$Stop; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Surveys$Stop; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/surveys/v2/surveys/{resourceId}/stop').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['resourceId'], - pathParams: ['resourceId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * surveys.surveys.update - * @desc Updates a survey. Currently the only property that can be updated is the owners property. - * @alias surveys.surveys.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.surveyUrlId External URL ID for the survey. - * @param {().Survey} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - update( - params?: Params$Resource$Surveys$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Surveys$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Surveys$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Surveys$Update - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Surveys$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Surveys$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/surveys/v2/surveys/{surveyUrlId}').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['surveyUrlId'], - pathParams: ['surveyUrlId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Surveys$Delete extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * External URL ID for the survey. - */ - surveyUrlId?: string; - } - export interface Params$Resource$Surveys$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * External URL ID for the survey. - */ - surveyUrlId?: string; - } - export interface Params$Resource$Surveys$Insert extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Request body metadata - */ - requestBody?: Schema$Survey; - } - export interface Params$Resource$Surveys$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * - */ - maxResults?: number; - /** - * - */ - startIndex?: number; - /** - * - */ - token?: string; - } - export interface Params$Resource$Surveys$Start extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * - */ - resourceId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SurveysStartRequest; - } - export interface Params$Resource$Surveys$Stop extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * - */ - resourceId?: string; - } - export interface Params$Resource$Surveys$Update extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * External URL ID for the survey. - */ - surveyUrlId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Survey; - } -} diff --git a/src/apis/tagmanager/v1.ts b/src/apis/tagmanager/v1.ts index 1f71239dd97..60a4099b038 100644 --- a/src/apis/tagmanager/v1.ts +++ b/src/apis/tagmanager/v1.ts @@ -41,9 +41,21 @@ export namespace tagmanager_v1 { interface StandardParameters { /** - * Data format for the response. + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. */ alt?: string; + /** + * JSONP + */ + callback?: string; /** * Selector specifying which fields to include in a partial response. */ @@ -61,19 +73,23 @@ export namespace tagmanager_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** - * Deprecated. Please use quotaUser instead. + * Legacy upload protocol for media (e.g. "media", "multipart"). */ - userIp?: string; + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; } /** * Tag Manager API * - * Accesses Tag Manager accounts and containers. + * This API allows clients to access and modify container and tag configuration. * * @example * const {google} = require('googleapis'); @@ -112,11 +128,11 @@ export namespace tagmanager_v1 { */ fingerprint?: string | null; /** - * Account display name. + * Account display name. @mutable tagmanager.accounts.create @mutable tagmanager.accounts.update */ name?: string | null; /** - * Whether the account shares data anonymously with Google and others. + * Whether the account shares data anonymously with Google and others. @mutable tagmanager.accounts.create @mutable tagmanager.accounts.update */ shareData?: boolean | null; } @@ -125,7 +141,7 @@ export namespace tagmanager_v1 { */ export interface Schema$AccountAccess { /** - * List of Account permissions. Valid account permissions are read and manage. + * List of Account permissions. Valid account permissions are <code>read</code> and <code>manage</code>. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update */ permission?: string[] | null; } @@ -134,11 +150,11 @@ export namespace tagmanager_v1 { */ export interface Schema$Condition { /** - * A list of named parameters (key/value), depending on the condition's type. Notes: - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - At this time, the left operand (arg0) must be a reference to a variable. - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. + * A list of named parameters (key/value), depending on the condition's type. Notes:<ul> <li>For binary operators, include parameters named <code>arg0</code> and <code>arg1</code> for specifying the left and right operands, respectively.</li> <li>At this time, the left operand (<code>arg0</code>) must be a reference to a variable.</li> <li>For case-insensitive Regex matching, include a boolean parameter named <code>ignore_case</code> that is set to <code>true</code>. If not specified or set to any other value, the matching will be case sensitive.</li> <li>To negate an operator, include a boolean parameter named <code>negate</code> boolean parameter that is set to <code>true</code>. </li> </ul> @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update */ parameter?: Schema$Parameter[]; /** - * The type of operator for this condition. + * The type of operator for this condition. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update */ type?: string | null; } @@ -155,23 +171,23 @@ export namespace tagmanager_v1 { */ containerId?: string | null; /** - * Optional list of domain names associated with the Container. + * Optional list of domain names associated with the Container. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update */ domainName?: string[] | null; /** - * List of enabled built-in variables. Valid values include: pageUrl, pageHostname, pagePath, referrer, event, clickElement, clickClasses, clickId, clickTarget, clickUrl, clickText, formElement, formClasses, formId, formTarget, formUrl, formText, errorMessage, errorUrl, errorLine, newHistoryFragment, oldHistoryFragment, newHistoryState, oldHistoryState, historySource, containerVersion, debugMode, randomNumber, containerId. + * List of enabled built-in variables. Valid values include: <code>pageUrl, pageHostname, pagePath, referrer, event, clickElement, clickClasses, clickId, clickTarget, clickUrl, clickText, formElement, formClasses, formId, formTarget, formUrl, formText, errorMessage, errorUrl, errorLine, newHistoryFragment, oldHistoryFragment, newHistoryState, oldHistoryState, historySource, containerVersion, debugMode, randomNumber, containerId</code>. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update */ enabledBuiltInVariable?: string[] | null; /** - * The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified. + * The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified. */ fingerprint?: string | null; /** - * Container display name. + * Container display name. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update */ name?: string | null; /** - * Container Notes. + * Container Notes. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update */ notes?: string | null; /** @@ -179,15 +195,15 @@ export namespace tagmanager_v1 { */ publicId?: string | null; /** - * Container Country ID. + * Container Country ID. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update */ timeZoneCountryId?: string | null; /** - * Container Time Zone ID. + * Container Time Zone ID. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update */ timeZoneId?: string | null; /** - * List of Usage Contexts for the Container. Valid values include: web, android, ios. + * List of Usage Contexts for the Container. Valid values include: <code>web, android, ios</code>. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update */ usageContext?: string[] | null; } @@ -196,11 +212,11 @@ export namespace tagmanager_v1 { */ export interface Schema$ContainerAccess { /** - * GTM Container ID. + * GTM Container ID. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update */ containerId?: string | null; /** - * List of Container permissions. Valid container permissions are: read, edit, delete, publish. + * List of Container permissions. Valid container permissions are: <code>read, edit, delete, publish</code>. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update */ permission?: string[] | null; } @@ -241,11 +257,11 @@ export namespace tagmanager_v1 { */ macro?: Schema$Macro[]; /** - * Container version display name. + * Container version display name. @mutable tagmanager.accounts.containers.versions.update */ name?: string | null; /** - * User notes on how to apply this container version in the container. + * User notes on how to apply this container version in the container. @mutable tagmanager.accounts.containers.versions.update */ notes?: string | null; /** @@ -362,11 +378,11 @@ export namespace tagmanager_v1 { containerId?: string | null; containerVersionId?: string | null; /** - * The environment description. Can be set or changed only on USER type environments. + * The environment description. Can be set or changed only on USER type environments. @mutable tagmanager.accounts.containers.environments.create @mutable tagmanager.accounts.containers.environments.update */ description?: string | null; /** - * Whether or not to enable debug by default on for the environment. + * Whether or not to enable debug by default on for the environment. @mutable tagmanager.accounts.containers.environments.create @mutable tagmanager.accounts.containers.environments.update */ enableDebug?: boolean | null; /** @@ -378,7 +394,7 @@ export namespace tagmanager_v1 { */ fingerprint?: string | null; /** - * The environment display name. Can be set or changed only on USER type environments. + * The environment display name. Can be set or changed only on USER type environments. @mutable tagmanager.accounts.containers.environments.create @mutable tagmanager.accounts.containers.environments.update */ name?: string | null; /** @@ -386,7 +402,7 @@ export namespace tagmanager_v1 { */ type?: string | null; /** - * Default preview page url for the environment. + * Default preview page url for the environment. @mutable tagmanager.accounts.containers.environments.create @mutable tagmanager.accounts.containers.environments.update */ url?: string | null; } @@ -411,7 +427,7 @@ export namespace tagmanager_v1 { */ folderId?: string | null; /** - * Folder display name. + * Folder display name. @mutable tagmanager.accounts.containers.folders.create @mutable tagmanager.accounts.containers.folders.update */ name?: string | null; } @@ -530,11 +546,11 @@ export namespace tagmanager_v1 { */ containerId?: string | null; /** - * For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. + * For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. @mutable tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts.containers.macros.update */ disablingRuleId?: string[] | null; /** - * For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. + * For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. @mutable tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts.containers.macros.update */ enablingRuleId?: string[] | null; /** @@ -546,15 +562,15 @@ export namespace tagmanager_v1 { */ macroId?: string | null; /** - * Macro display name. + * Macro display name. @mutable tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts.containers.macros.update */ name?: string | null; /** - * User notes on how to apply this macro in the container. + * User notes on how to apply this macro in the container. @mutable tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts.containers.macros.update */ notes?: string | null; /** - * The macro's parameters. + * The macro's parameters. @mutable tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts.containers.macros.update */ parameter?: Schema$Parameter[]; /** @@ -562,15 +578,15 @@ export namespace tagmanager_v1 { */ parentFolderId?: string | null; /** - * The end timestamp in milliseconds to schedule a macro. + * The end timestamp in milliseconds to schedule a macro. @mutable tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts.containers.macros.update */ scheduleEndMs?: string | null; /** - * The start timestamp in milliseconds to schedule a macro. + * The start timestamp in milliseconds to schedule a macro. @mutable tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts.containers.macros.update */ scheduleStartMs?: string | null; /** - * GTM Macro Type. + * GTM Macro Type. @mutable tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts.containers.macros.update */ type?: string | null; } @@ -579,23 +595,23 @@ export namespace tagmanager_v1 { */ export interface Schema$Parameter { /** - * The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. + * The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update */ key?: string | null; /** - * This list parameter's parameters (keys will be ignored). + * This list parameter's parameters (keys will be ignored). @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update */ list?: Schema$Parameter[]; /** - * This map parameter's parameters (must have keys; keys must be unique). + * This map parameter's parameters (must have keys; keys must be unique). @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update */ map?: Schema$Parameter[]; /** - * The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id + * The parameter type. Valid values are:<ul> <li><code>boolean</code>: The value represents a boolean, represented as 'true' or 'false'</li> <li><code>integer</code>: The value represents a 64-bit signed integer value, in base 10</li> <li><code>list</code>: A list of parameters should be specified</li> <li><code>map</code>: A map of parameters should be specified</li> <li><code>template</code>: The value represents any text; this can include variable references (even variable references that might return non-string types)</li> <li><code>trigger_reference</code>: The value represents a trigger, represented as the trigger id</li> <li><code>tag_reference</code>: The value represents a tag, represented as the tag name</li> </ul> @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update */ type?: string | null; /** - * A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. + * A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update */ value?: string | null; } @@ -621,7 +637,7 @@ export namespace tagmanager_v1 { */ accountId?: string | null; /** - * The list of conditions that make up this rule (implicit AND between them). + * The list of conditions that make up this rule (implicit AND between them). @mutable tagmanager.accounts.containers.rules.create @mutable tagmanager.accounts.containers.rules.update */ condition?: Schema$Condition[]; /** @@ -633,11 +649,11 @@ export namespace tagmanager_v1 { */ fingerprint?: string | null; /** - * Rule display name. + * Rule display name. @mutable tagmanager.accounts.containers.rules.create @mutable tagmanager.accounts.containers.rules.update */ name?: string | null; /** - * User notes on how to apply this rule in the container. + * User notes on how to apply this rule in the container. @mutable tagmanager.accounts.containers.rules.create @mutable tagmanager.accounts.containers.rules.update */ notes?: string | null; /** @@ -664,11 +680,11 @@ export namespace tagmanager_v1 { */ accountId?: string | null; /** - * Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire. + * Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update */ blockingRuleId?: string[] | null; /** - * Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire. + * Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update */ blockingTriggerId?: string[] | null; /** @@ -680,27 +696,27 @@ export namespace tagmanager_v1 { */ fingerprint?: string | null; /** - * Firing rule IDs. A tag will fire when any of the listed rules are true and all of its blockingRuleIds (if any specified) are false. + * Firing rule IDs. A tag will fire when any of the listed rules are true and all of its <code>blockingRuleIds</code> (if any specified) are false. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update */ firingRuleId?: string[] | null; /** - * Firing trigger IDs. A tag will fire when any of the listed triggers are true and all of its blockingTriggerIds (if any specified) are false. + * Firing trigger IDs. A tag will fire when any of the listed triggers are true and all of its <code>blockingTriggerIds</code> (if any specified) are false. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update */ firingTriggerId?: string[] | null; /** - * If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode). + * If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode). @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update */ liveOnly?: boolean | null; /** - * Tag display name. + * Tag display name. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update */ name?: string | null; /** - * User notes on how to apply this tag in the container. + * User notes on how to apply this tag in the container. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update */ notes?: string | null; /** - * The tag's parameters. + * The tag's parameters. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update */ parameter?: Schema$Parameter[]; /** @@ -708,19 +724,19 @@ export namespace tagmanager_v1 { */ parentFolderId?: string | null; /** - * True if the tag is paused. + * True if the tag is paused. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update */ paused?: boolean | null; /** - * User defined numeric priority of the tag. Tags are fired asynchronously in order of priority. Tags with higher numeric value fire first. A tag's priority can be a positive or negative value. The default value is 0. + * User defined numeric priority of the tag. Tags are fired asynchronously in order of priority. Tags with higher numeric value fire first. A tag's priority can be a positive or negative value. The default value is 0. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update */ priority?: Schema$Parameter; /** - * The end timestamp in milliseconds to schedule a tag. + * The end timestamp in milliseconds to schedule a tag. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update */ scheduleEndMs?: string | null; /** - * The start timestamp in milliseconds to schedule a tag. + * The start timestamp in milliseconds to schedule a tag. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update */ scheduleStartMs?: string | null; /** @@ -740,7 +756,7 @@ export namespace tagmanager_v1 { */ teardownTag?: Schema$TeardownTag[]; /** - * GTM Tag Type. + * GTM Tag Type. @mutable tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags.update */ type?: string | null; } @@ -763,11 +779,11 @@ export namespace tagmanager_v1 { */ accountId?: string | null; /** - * Used in the case of auto event tracking. + * Used in the case of auto event tracking. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update */ autoEventFilter?: Schema$Condition[]; /** - * Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers. + * Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update */ checkValidation?: Schema$Parameter; /** @@ -775,19 +791,19 @@ export namespace tagmanager_v1 { */ containerId?: string | null; /** - * A visibility trigger minimum continuous visible time (in milliseconds). Only valid for AMP Visibility trigger. + * A visibility trigger minimum continuous visible time (in milliseconds). Only valid for AMP Visibility trigger. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update */ continuousTimeMinMilliseconds?: Schema$Parameter; /** - * Used in the case of custom event, which is fired iff all Conditions are true. + * Used in the case of custom event, which is fired iff all Conditions are true. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update */ customEventFilter?: Schema$Condition[]; /** - * Name of the GTM event that is fired. Only valid for Timer triggers. + * Name of the GTM event that is fired. Only valid for Timer triggers. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update */ eventName?: Schema$Parameter; /** - * The trigger will only fire iff all Conditions are true. + * The trigger will only fire iff all Conditions are true. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update */ filter?: Schema$Condition[]; /** @@ -795,31 +811,31 @@ export namespace tagmanager_v1 { */ fingerprint?: string | null; /** - * List of integer percentage values for scroll triggers. The trigger will fire when each percentage is reached when the view is scrolled horizontally. Only valid for AMP scroll triggers. + * List of integer percentage values for scroll triggers. The trigger will fire when each percentage is reached when the view is scrolled horizontally. Only valid for AMP scroll triggers. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update */ horizontalScrollPercentageList?: Schema$Parameter; /** - * Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers. + * Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update */ interval?: Schema$Parameter; /** - * Time between Timer Events to fire (in seconds). Only valid for AMP Timer trigger. + * Time between Timer Events to fire (in seconds). Only valid for AMP Timer trigger. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update */ intervalSeconds?: Schema$Parameter; /** - * Limit of the number of GTM events this Timer Trigger will fire. If no limit is set, we will continue to fire GTM events until the user leaves the page. Only valid for Timer triggers. + * Limit of the number of GTM events this Timer Trigger will fire. If no limit is set, we will continue to fire GTM events until the user leaves the page. Only valid for Timer triggers. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update */ limit?: Schema$Parameter; /** - * Max time to fire Timer Events (in seconds). Only valid for AMP Timer trigger. + * Max time to fire Timer Events (in seconds). Only valid for AMP Timer trigger. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update */ maxTimerLengthSeconds?: Schema$Parameter; /** - * Trigger display name. + * Trigger display name. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update */ name?: string | null; /** - * Additional parameters. + * Additional parameters. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update */ parameter?: Schema$Parameter[]; /** @@ -827,11 +843,11 @@ export namespace tagmanager_v1 { */ parentFolderId?: string | null; /** - * A click trigger CSS selector (i.e. "a", "button" etc.). Only valid for AMP Click trigger. + * A click trigger CSS selector (i.e. "a", "button" etc.). Only valid for AMP Click trigger. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update */ selector?: Schema$Parameter; /** - * A visibility trigger minimum total visible time (in milliseconds). Only valid for AMP Visibility trigger. + * A visibility trigger minimum total visible time (in milliseconds). Only valid for AMP Visibility trigger. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update */ totalTimeMinMilliseconds?: Schema$Parameter; /** @@ -839,35 +855,35 @@ export namespace tagmanager_v1 { */ triggerId?: string | null; /** - * Defines the data layer event that causes this trigger. + * Defines the data layer event that causes this trigger. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update */ type?: string | null; /** - * Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers. + * Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update */ uniqueTriggerId?: Schema$Parameter; /** - * List of integer percentage values for scroll triggers. The trigger will fire when each percentage is reached when the view is scrolled vertically. Only valid for AMP scroll triggers. + * List of integer percentage values for scroll triggers. The trigger will fire when each percentage is reached when the view is scrolled vertically. Only valid for AMP scroll triggers. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update */ verticalScrollPercentageList?: Schema$Parameter; /** - * A visibility trigger CSS selector (i.e. "#id"). Only valid for AMP Visibility trigger. + * A visibility trigger CSS selector (i.e. "#id"). Only valid for AMP Visibility trigger. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update */ visibilitySelector?: Schema$Parameter; /** - * A visibility trigger maximum percent visibility. Only valid for AMP Visibility trigger. + * A visibility trigger maximum percent visibility. Only valid for AMP Visibility trigger. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update */ visiblePercentageMax?: Schema$Parameter; /** - * A visibility trigger minimum percent visibility. Only valid for AMP Visibility trigger. + * A visibility trigger minimum percent visibility. Only valid for AMP Visibility trigger. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update */ visiblePercentageMin?: Schema$Parameter; /** - * Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers. + * Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update */ waitForTags?: Schema$Parameter; /** - * How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers. + * How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to <code>true</code>. Only valid for Form Submission and Link Click triggers. @mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager.accounts.containers.triggers.update */ waitForTagsTimeout?: Schema$Parameter; } @@ -876,7 +892,7 @@ export namespace tagmanager_v1 { */ export interface Schema$UserAccess { /** - * GTM Account access permissions. + * GTM Account access permissions. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update */ accountAccess?: Schema$AccountAccess; /** @@ -884,11 +900,11 @@ export namespace tagmanager_v1 { */ accountId?: string | null; /** - * GTM Container access permissions. + * GTM Container access permissions. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update */ containerAccess?: Schema$ContainerAccess[]; /** - * User's email address. + * User's email address. @mutable tagmanager.accounts.permissions.create */ emailAddress?: string | null; /** @@ -909,11 +925,11 @@ export namespace tagmanager_v1 { */ containerId?: string | null; /** - * For mobile containers only: A list of trigger IDs for disabling conditional variables; the variable is enabled if one of the enabling trigger is true while all the disabling trigger are false. Treated as an unordered set. + * For mobile containers only: A list of trigger IDs for disabling conditional variables; the variable is enabled if one of the enabling trigger is true while all the disabling trigger are false. Treated as an unordered set. @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update */ disablingTriggerId?: string[] | null; /** - * For mobile containers only: A list of trigger IDs for enabling conditional variables; the variable is enabled if one of the enabling triggers is true while all the disabling triggers are false. Treated as an unordered set. + * For mobile containers only: A list of trigger IDs for enabling conditional variables; the variable is enabled if one of the enabling triggers is true while all the disabling triggers are false. Treated as an unordered set. @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update */ enablingTriggerId?: string[] | null; /** @@ -921,15 +937,15 @@ export namespace tagmanager_v1 { */ fingerprint?: string | null; /** - * Variable display name. + * Variable display name. @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update */ name?: string | null; /** - * User notes on how to apply this variable in the container. + * User notes on how to apply this variable in the container. @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update */ notes?: string | null; /** - * The variable's parameters. + * The variable's parameters. @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update */ parameter?: Schema$Parameter[]; /** @@ -937,15 +953,15 @@ export namespace tagmanager_v1 { */ parentFolderId?: string | null; /** - * The end timestamp in milliseconds to schedule a variable. + * The end timestamp in milliseconds to schedule a variable. @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update */ scheduleEndMs?: string | null; /** - * The start timestamp in milliseconds to schedule a variable. + * The start timestamp in milliseconds to schedule a variable. @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update */ scheduleStartMs?: string | null; /** - * GTM Variable Type. + * GTM Variable Type. @mutable tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts.containers.variables.update */ type?: string | null; /** @@ -1041,7 +1057,7 @@ export namespace tagmanager_v1 { * @alias tagmanager.accounts.list * @memberOf! () * - * @param {object=} params Parameters for request + * @param {object} params Parameters for request * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4673,7 +4689,7 @@ export namespace tagmanager_v1 { * @param {object} params Parameters for request * @param {string} params.accountId The GTM Account ID. * @param {string} params.containerId The GTM Container ID. - * @param {string} params.containerVersionId The GTM Container Version ID. Specify published to retrieve the currently published version. + * @param {string} params.containerVersionId The GTM Container Version ID. Specify published to retrieve the currently published version. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5200,7 +5216,7 @@ export namespace tagmanager_v1 { */ containerId?: string; /** - * The GTM Container Version ID. Specify published to retrieve the currently published version. + * The GTM Container Version ID. Specify published to retrieve the currently published version. */ containerVersionId?: string; } @@ -5557,7 +5573,7 @@ export namespace tagmanager_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId The GTM Account ID. @required tagmanager.accounts.permissions.list + * @param {string} params.accountId The GTM Account ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5759,7 +5775,7 @@ export namespace tagmanager_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The GTM Account ID. @required tagmanager.accounts.permissions.list + * The GTM Account ID. */ accountId?: string; } diff --git a/src/apis/tagmanager/v2.ts b/src/apis/tagmanager/v2.ts index 4ce01a3b078..234791b8f19 100644 --- a/src/apis/tagmanager/v2.ts +++ b/src/apis/tagmanager/v2.ts @@ -41,9 +41,21 @@ export namespace tagmanager_v2 { interface StandardParameters { /** - * Data format for the response. + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. */ alt?: string; + /** + * JSONP + */ + callback?: string; /** * Selector specifying which fields to include in a partial response. */ @@ -61,19 +73,23 @@ export namespace tagmanager_v2 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** - * Deprecated. Please use quotaUser instead. + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). */ - userIp?: string; + upload_protocol?: string; } /** * Tag Manager API * - * Accesses Tag Manager accounts and containers. + * This API allows clients to access and modify container and tag configuration. * * @example * const {google} = require('googleapis'); @@ -112,7 +128,7 @@ export namespace tagmanager_v2 { */ fingerprint?: string | null; /** - * Account display name. + * Account display name. @mutable tagmanager.accounts.create @mutable tagmanager.accounts.update */ name?: string | null; /** @@ -120,7 +136,7 @@ export namespace tagmanager_v2 { */ path?: string | null; /** - * Whether the account shares data anonymously with Google and others. This flag enables benchmarking by sharing your data in an anonymous form. Google will remove all identifiable information about your website, combine the data with hundreds of other anonymous sites and report aggregate trends in the benchmarking service. + * Whether the account shares data anonymously with Google and others. This flag enables benchmarking by sharing your data in an anonymous form. Google will remove all identifiable information about your website, combine the data with hundreds of other anonymous sites and report aggregate trends in the benchmarking service. @mutable tagmanager.accounts.create @mutable tagmanager.accounts.update */ shareData?: boolean | null; /** @@ -133,7 +149,7 @@ export namespace tagmanager_v2 { */ export interface Schema$AccountAccess { /** - * Whether the user has no access, user access, or admin access to an account. + * Whether the user has no access, user access, or admin access to an account. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update */ permission?: string | null; } @@ -158,7 +174,53 @@ export namespace tagmanager_v2 { */ path?: string | null; /** - * Type of built-in variable. + * Type of built-in variable. @required.tagmanager.accounts.containers.workspaces.built_in_variable.update @mutable tagmanager.accounts.containers.workspaces.built_in_variable.update + */ + type?: string | null; + /** + * GTM Workspace ID. + */ + workspaceId?: string | null; + } + export interface Schema$Client { + /** + * GTM Account ID. + */ + accountId?: string | null; + /** + * The Client ID uniquely identifies the GTM client. + */ + clientId?: string | null; + /** + * GTM Container ID. + */ + containerId?: string | null; + /** + * The fingerprint of the GTM Client as computed at storage time. This value is recomputed whenever the client is modified. + */ + fingerprint?: string | null; + /** + * Client display name. @mutable tagmanager.accounts.containers.workspaces.clients.create @mutable tagmanager.accounts.containers.workspaces.clients.update + */ + name?: string | null; + /** + * The client's parameters. @mutable tagmanager.accounts.containers.workspaces.clients.create @mutable tagmanager.accounts.containers.workspaces.clients.update + */ + parameter?: Schema$Parameter[]; + /** + * GTM client's API relative path. + */ + path?: string | null; + /** + * Priority determines relative firing order. @mutable tagmanager.accounts.containers.workspaces.clients.create @mutable tagmanager.accounts.containers.workspaces.clients.update + */ + priority?: number | null; + /** + * Auto generated link to the tag manager UI + */ + tagManagerUrl?: string | null; + /** + * Client type. @mutable tagmanager.accounts.containers.workspaces.clients.create @mutable tagmanager.accounts.containers.workspaces.clients.update */ type?: string | null; /** @@ -171,11 +233,11 @@ export namespace tagmanager_v2 { */ export interface Schema$Condition { /** - * A list of named parameters (key/value), depending on the condition's type. Notes: - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - At this time, the left operand (arg0) must be a reference to a variable. - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. + * A list of named parameters (key/value), depending on the condition's type. Notes:<ul> <li>For binary operators, include parameters named <code>arg0</code> and <code>arg1</code> for specifying the left and right operands, respectively.</li> <li>At this time, the left operand (<code>arg0</code>) must be a reference to a variable.</li> <li>For case-insensitive Regex matching, include a boolean parameter named <code>ignore_case</code> that is set to <code>true</code>. If not specified or set to any other value, the matching will be case sensitive.</li> <li>To negate an operator, include a boolean parameter named <code>negate</code> boolean parameter that is set to <code>true</code>. </li> </ul> @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update */ parameter?: Schema$Parameter[]; /** - * The type of operator for this condition. + * The type of operator for this condition. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update */ type?: string | null; } @@ -192,19 +254,19 @@ export namespace tagmanager_v2 { */ containerId?: string | null; /** - * List of domain names associated with the Container. + * List of domain names associated with the Container. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update */ domainName?: string[] | null; /** - * The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified. + * The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified. */ fingerprint?: string | null; /** - * Container display name. + * Container display name. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update */ name?: string | null; /** - * Container Notes. + * Container Notes. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update */ notes?: string | null; /** @@ -220,7 +282,7 @@ export namespace tagmanager_v2 { */ tagManagerUrl?: string | null; /** - * List of Usage Contexts for the Container. Valid values include: web, android, or ios. + * List of Usage Contexts for the Container. Valid values include: <code>web, android, or ios</code>. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update */ usageContext?: string[] | null; } @@ -229,11 +291,11 @@ export namespace tagmanager_v2 { */ export interface Schema$ContainerAccess { /** - * GTM Container ID. + * GTM Container ID. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update */ containerId?: string | null; /** - * List of Container permissions. + * List of Container permissions. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update */ permission?: string | null; } @@ -249,6 +311,10 @@ export namespace tagmanager_v2 { * The built-in variables in the container that this version was taken from. */ builtInVariable?: Schema$BuiltInVariable[]; + /** + * The clients in the container that this version was taken from. + */ + client?: Schema$Client[]; /** * The container that this version was taken from. */ @@ -270,7 +336,7 @@ export namespace tagmanager_v2 { */ deleted?: boolean | null; /** - * Container version description. + * Container version description. @mutable tagmanager.accounts.containers.versions.update */ description?: string | null; /** @@ -282,7 +348,7 @@ export namespace tagmanager_v2 { */ folder?: Schema$Folder[]; /** - * Container version display name. + * Container version display name. @mutable tagmanager.accounts.containers.versions.update */ name?: string | null; /** @@ -423,6 +489,10 @@ export namespace tagmanager_v2 { * The fingerprint of the GTM Custom Template as computed at storage time. This value is recomputed whenever the template is modified. */ fingerprint?: string | null; + /** + * A reference to the Community Template Gallery entry. + */ + galleryReference?: Schema$GalleryReference; /** * Custom Template display name. */ @@ -488,7 +558,7 @@ export namespace tagmanager_v2 { /** * The last update time-stamp for the authorization code. */ - authorizationTimestamp?: Schema$Timestamp; + authorizationTimestamp?: string | null; /** * GTM Container ID. */ @@ -498,11 +568,11 @@ export namespace tagmanager_v2 { */ containerVersionId?: string | null; /** - * The environment description. Can be set or changed only on USER type environments. + * The environment description. Can be set or changed only on USER type environments. @mutable tagmanager.accounts.containers.environments.create @mutable tagmanager.accounts.containers.environments.update */ description?: string | null; /** - * Whether or not to enable debug by default for the environment. + * Whether or not to enable debug by default for the environment. @mutable tagmanager.accounts.containers.environments.create @mutable tagmanager.accounts.containers.environments.update */ enableDebug?: boolean | null; /** @@ -514,7 +584,7 @@ export namespace tagmanager_v2 { */ fingerprint?: string | null; /** - * The environment display name. Can be set or changed only on USER type environments. + * The environment display name. Can be set or changed only on USER type environments. @mutable tagmanager.accounts.containers.environments.create @mutable tagmanager.accounts.containers.environments.update */ name?: string | null; /** @@ -530,7 +600,7 @@ export namespace tagmanager_v2 { */ type?: string | null; /** - * Default preview page url for the environment. + * Default preview page url for the environment. @mutable tagmanager.accounts.containers.environments.create @mutable tagmanager.accounts.containers.environments.update */ url?: string | null; /** @@ -559,11 +629,11 @@ export namespace tagmanager_v2 { */ folderId?: string | null; /** - * Folder display name. + * Folder display name. @mutable tagmanager.accounts.containers.workspaces.folders.create @mutable tagmanager.accounts.containers.workspaces.folders.update */ name?: string | null; /** - * User notes on how to apply this folder in the container. + * User notes on how to apply this folder in the container. @mutable tagmanager.accounts.containers.workspaces.folders.create @mutable tagmanager.accounts.containers.workspaces.folders.update */ notes?: string | null; /** @@ -600,6 +670,35 @@ export namespace tagmanager_v2 { */ variable?: Schema$Variable[]; } + /** + * Represents the link between a custom template and an entry on the Community Template Gallery site. + */ + export interface Schema$GalleryReference { + /** + * The name of the host for the community gallery template. + */ + host?: string | null; + /** + * If a user has manually edited the community gallery template. + */ + isModified?: boolean | null; + /** + * The name of the owner for the community gallery template. + */ + owner?: string | null; + /** + * The name of the repository for the community gallery template. + */ + repository?: string | null; + /** + * The signature of the community gallery template as computed at import time. This value is recomputed whenever the template is updated from the gallery. + */ + signature?: string | null; + /** + * The version of the community gallery template. + */ + version?: string | null; + } /** * The changes that have occurred in the workspace since the base container version. */ @@ -794,23 +893,23 @@ export namespace tagmanager_v2 { */ export interface Schema$Parameter { /** - * The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. + * The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update */ key?: string | null; /** - * This list parameter's parameters (keys will be ignored). + * This list parameter's parameters (keys will be ignored). @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update */ list?: Schema$Parameter[]; /** - * This map parameter's parameters (must have keys; keys must be unique). + * This map parameter's parameters (must have keys; keys must be unique). @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update */ map?: Schema$Parameter[]; /** - * The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id + * The parameter type. Valid values are:<ul> <li><code>boolean</code>: The value represents a boolean, represented as 'true' or 'false'</li> <li><code>integer</code>: The value represents a 64-bit signed integer value, in base 10</li> <li><code>list</code>: A list of parameters should be specified</li> <li><code>map</code>: A map of parameters should be specified</li> <li><code>template</code>: The value represents any text; this can include variable references (even variable references that might return non-string types)</li> <li><code>trigger_reference</code>: The value represents a trigger, represented as the trigger id</li> <li><code>tag_reference</code>: The value represents a tag, represented as the tag name</li> </ul> @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update */ type?: string | null; /** - * A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. + * A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update */ value?: string | null; } @@ -955,11 +1054,11 @@ export namespace tagmanager_v2 { */ accountId?: string | null; /** - * Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire. + * Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update */ blockingRuleId?: string[] | null; /** - * Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire. + * Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update */ blockingTriggerId?: string[] | null; /** @@ -971,27 +1070,35 @@ export namespace tagmanager_v2 { */ fingerprint?: string | null; /** - * Firing rule IDs. A tag will fire when any of the listed rules are true and all of its blockingRuleIds (if any specified) are false. + * Firing rule IDs. A tag will fire when any of the listed rules are true and all of its <code>blockingRuleIds</code> (if any specified) are false. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update */ firingRuleId?: string[] | null; /** - * Firing trigger IDs. A tag will fire when any of the listed triggers are true and all of its blockingTriggerIds (if any specified) are false. + * Firing trigger IDs. A tag will fire when any of the listed triggers are true and all of its <code>blockingTriggerIds</code> (if any specified) are false. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update */ firingTriggerId?: string[] | null; /** - * If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode). + * If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode). @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update */ liveOnly?: boolean | null; /** - * Tag display name. + * A map of key-value pairs of tag metadata to be included in the event data for tag monitoring. Notes:<ul> <li>This parameter must be type <code>MAP</code>.</li> <li>Each parameter in the map are type <code>TEMPLATE</code>, however cannot contain variable references.</li> </ul> @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update + */ + monitoringMetadata?: Schema$Parameter; + /** + * If non-empty, then the tag display name will be included in the monitoring metadata map using the key specified. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update + */ + monitoringMetadataTagNameKey?: string | null; + /** + * Tag display name. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update */ name?: string | null; /** - * User notes on how to apply this tag in the container. + * User notes on how to apply this tag in the container. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update */ notes?: string | null; /** - * The tag's parameters. + * The tag's parameters. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update */ parameter?: Schema$Parameter[]; /** @@ -1003,19 +1110,19 @@ export namespace tagmanager_v2 { */ path?: string | null; /** - * Indicates whether the tag is paused, which prevents the tag from firing. + * Indicates whether the tag is paused, which prevents the tag from firing. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update */ paused?: boolean | null; /** - * User defined numeric priority of the tag. Tags are fired asynchronously in order of priority. Tags with higher numeric value fire first. A tag's priority can be a positive or negative value. The default value is 0. + * User defined numeric priority of the tag. Tags are fired asynchronously in order of priority. Tags with higher numeric value fire first. A tag's priority can be a positive or negative value. The default value is 0. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update */ priority?: Schema$Parameter; /** - * The end timestamp in milliseconds to schedule a tag. + * The end timestamp in milliseconds to schedule a tag. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update */ scheduleEndMs?: string | null; /** - * The start timestamp in milliseconds to schedule a tag. + * The start timestamp in milliseconds to schedule a tag. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update */ scheduleStartMs?: string | null; /** @@ -1039,7 +1146,7 @@ export namespace tagmanager_v2 { */ teardownTag?: Schema$TeardownTag[]; /** - * GTM Tag Type. + * GTM Tag Type. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update */ type?: string | null; /** @@ -1060,19 +1167,6 @@ export namespace tagmanager_v2 { */ tagName?: string | null; } - /** - * A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Examples Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; gettimeofday(&tv, NULL); Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON Mapping In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`]( http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D ) to obtain a formatter capable of generating timestamps in this format. - */ - export interface Schema$Timestamp { - /** - * Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. - */ - nanos?: number | null; - /** - * Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive. - */ - seconds?: string | null; - } /** * Represents a Google Tag Manager Trigger */ @@ -1082,11 +1176,11 @@ export namespace tagmanager_v2 { */ accountId?: string | null; /** - * Used in the case of auto event tracking. + * Used in the case of auto event tracking. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update */ autoEventFilter?: Schema$Condition[]; /** - * Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers. + * Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update */ checkValidation?: Schema$Parameter; /** @@ -1094,19 +1188,19 @@ export namespace tagmanager_v2 { */ containerId?: string | null; /** - * A visibility trigger minimum continuous visible time (in milliseconds). Only valid for AMP Visibility trigger. + * A visibility trigger minimum continuous visible time (in milliseconds). Only valid for AMP Visibility trigger. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update */ continuousTimeMinMilliseconds?: Schema$Parameter; /** - * Used in the case of custom event, which is fired iff all Conditions are true. + * Used in the case of custom event, which is fired iff all Conditions are true. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update */ customEventFilter?: Schema$Condition[]; /** - * Name of the GTM event that is fired. Only valid for Timer triggers. + * Name of the GTM event that is fired. Only valid for Timer triggers. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update */ eventName?: Schema$Parameter; /** - * The trigger will only fire iff all Conditions are true. + * The trigger will only fire iff all Conditions are true. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update */ filter?: Schema$Condition[]; /** @@ -1114,35 +1208,35 @@ export namespace tagmanager_v2 { */ fingerprint?: string | null; /** - * List of integer percentage values for scroll triggers. The trigger will fire when each percentage is reached when the view is scrolled horizontally. Only valid for AMP scroll triggers. + * List of integer percentage values for scroll triggers. The trigger will fire when each percentage is reached when the view is scrolled horizontally. Only valid for AMP scroll triggers. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update */ horizontalScrollPercentageList?: Schema$Parameter; /** - * Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers. + * Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update */ interval?: Schema$Parameter; /** - * Time between Timer Events to fire (in seconds). Only valid for AMP Timer trigger. + * Time between Timer Events to fire (in seconds). Only valid for AMP Timer trigger. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update */ intervalSeconds?: Schema$Parameter; /** - * Limit of the number of GTM events this Timer Trigger will fire. If no limit is set, we will continue to fire GTM events until the user leaves the page. Only valid for Timer triggers. + * Limit of the number of GTM events this Timer Trigger will fire. If no limit is set, we will continue to fire GTM events until the user leaves the page. Only valid for Timer triggers. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update */ limit?: Schema$Parameter; /** - * Max time to fire Timer Events (in seconds). Only valid for AMP Timer trigger. + * Max time to fire Timer Events (in seconds). Only valid for AMP Timer trigger. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update */ maxTimerLengthSeconds?: Schema$Parameter; /** - * Trigger display name. + * Trigger display name. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update */ name?: string | null; /** - * User notes on how to apply this trigger in the container. + * User notes on how to apply this trigger in the container. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update */ notes?: string | null; /** - * Additional parameters. + * Additional parameters. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update */ parameter?: Schema$Parameter[]; /** @@ -1154,7 +1248,7 @@ export namespace tagmanager_v2 { */ path?: string | null; /** - * A click trigger CSS selector (i.e. "a", "button" etc.). Only valid for AMP Click trigger. + * A click trigger CSS selector (i.e. "a", "button" etc.). Only valid for AMP Click trigger. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update */ selector?: Schema$Parameter; /** @@ -1162,7 +1256,7 @@ export namespace tagmanager_v2 { */ tagManagerUrl?: string | null; /** - * A visibility trigger minimum total visible time (in milliseconds). Only valid for AMP Visibility trigger. + * A visibility trigger minimum total visible time (in milliseconds). Only valid for AMP Visibility trigger. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update */ totalTimeMinMilliseconds?: Schema$Parameter; /** @@ -1170,35 +1264,35 @@ export namespace tagmanager_v2 { */ triggerId?: string | null; /** - * Defines the data layer event that causes this trigger. + * Defines the data layer event that causes this trigger. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update */ type?: string | null; /** - * Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers. + * Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update */ uniqueTriggerId?: Schema$Parameter; /** - * List of integer percentage values for scroll triggers. The trigger will fire when each percentage is reached when the view is scrolled vertically. Only valid for AMP scroll triggers. + * List of integer percentage values for scroll triggers. The trigger will fire when each percentage is reached when the view is scrolled vertically. Only valid for AMP scroll triggers. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update */ verticalScrollPercentageList?: Schema$Parameter; /** - * A visibility trigger CSS selector (i.e. "#id"). Only valid for AMP Visibility trigger. + * A visibility trigger CSS selector (i.e. "#id"). Only valid for AMP Visibility trigger. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update */ visibilitySelector?: Schema$Parameter; /** - * A visibility trigger maximum percent visibility. Only valid for AMP Visibility trigger. + * A visibility trigger maximum percent visibility. Only valid for AMP Visibility trigger. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update */ visiblePercentageMax?: Schema$Parameter; /** - * A visibility trigger minimum percent visibility. Only valid for AMP Visibility trigger. + * A visibility trigger minimum percent visibility. Only valid for AMP Visibility trigger. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update */ visiblePercentageMin?: Schema$Parameter; /** - * Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers. + * Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update */ waitForTags?: Schema$Parameter; /** - * How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers. + * How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to <code>true</code>. Only valid for Form Submission and Link Click triggers. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update */ waitForTagsTimeout?: Schema$Parameter; /** @@ -1211,7 +1305,7 @@ export namespace tagmanager_v2 { */ export interface Schema$UserPermission { /** - * GTM Account access permissions. + * GTM Account access permissions. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update */ accountAccess?: Schema$AccountAccess; /** @@ -1219,11 +1313,11 @@ export namespace tagmanager_v2 { */ accountId?: string | null; /** - * GTM Container access permissions. + * GTM Container access permissions. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update */ containerAccess?: Schema$ContainerAccess[]; /** - * User's email address. + * User's email address. @mutable tagmanager.accounts.permissions.create */ emailAddress?: string | null; /** @@ -1244,11 +1338,11 @@ export namespace tagmanager_v2 { */ containerId?: string | null; /** - * For mobile containers only: A list of trigger IDs for disabling conditional variables; the variable is enabled if one of the enabling trigger is true while all the disabling trigger are false. Treated as an unordered set. + * For mobile containers only: A list of trigger IDs for disabling conditional variables; the variable is enabled if one of the enabling trigger is true while all the disabling trigger are false. Treated as an unordered set. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update */ disablingTriggerId?: string[] | null; /** - * For mobile containers only: A list of trigger IDs for enabling conditional variables; the variable is enabled if one of the enabling triggers is true while all the disabling triggers are false. Treated as an unordered set. + * For mobile containers only: A list of trigger IDs for enabling conditional variables; the variable is enabled if one of the enabling triggers is true while all the disabling triggers are false. Treated as an unordered set. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update */ enablingTriggerId?: string[] | null; /** @@ -1260,15 +1354,15 @@ export namespace tagmanager_v2 { */ formatValue?: Schema$VariableFormatValue; /** - * Variable display name. + * Variable display name. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update */ name?: string | null; /** - * User notes on how to apply this variable in the container. + * User notes on how to apply this variable in the container. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update */ notes?: string | null; /** - * The variable's parameters. + * The variable's parameters. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update */ parameter?: Schema$Parameter[]; /** @@ -1280,11 +1374,11 @@ export namespace tagmanager_v2 { */ path?: string | null; /** - * The end timestamp in milliseconds to schedule a variable. + * The end timestamp in milliseconds to schedule a variable. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update */ scheduleEndMs?: string | null; /** - * The start timestamp in milliseconds to schedule a variable. + * The start timestamp in milliseconds to schedule a variable. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update */ scheduleStartMs?: string | null; /** @@ -1292,7 +1386,7 @@ export namespace tagmanager_v2 { */ tagManagerUrl?: string | null; /** - * GTM Variable Type. + * GTM Variable Type. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update */ type?: string | null; /** @@ -1339,7 +1433,7 @@ export namespace tagmanager_v2 { */ containerId?: string | null; /** - * Workspace description. + * Workspace description. @mutable tagmanager.accounts.containers.workspaces.create @mutable tagmanager.accounts.containers.workspaces.update */ description?: string | null; /** @@ -1347,7 +1441,7 @@ export namespace tagmanager_v2 { */ fingerprint?: string | null; /** - * Workspace display name. + * Workspace display name. @mutable tagmanager.accounts.containers.workspaces.create @mutable tagmanager.accounts.containers.workspaces.update */ name?: string | null; /** @@ -1545,7 +1639,7 @@ export namespace tagmanager_v2 { * @alias tagmanager.accounts.list * @memberOf! () * - * @param {object=} params Parameters for request + * @param {object} params Parameters for request * @param {string=} params.pageToken Continuation token for fetching the next page of results. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2842,7 +2936,7 @@ export namespace tagmanager_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.containerVersionId The GTM ContainerVersion ID. Specify published to retrieve the currently published version. + * @param {string=} params.containerVersionId The GTM ContainerVersion ID. Specify published to retrieve the currently published version. * @param {string} params.path GTM ContainerVersion's API relative path. Example: accounts/{account_id}/containers/{container_id}/versions/{version_id} * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3313,7 +3407,7 @@ export namespace tagmanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The GTM ContainerVersion ID. Specify published to retrieve the currently published version. + * The GTM ContainerVersion ID. Specify published to retrieve the currently published version. */ containerVersionId?: string; /** diff --git a/src/apis/testing/v1.ts b/src/apis/testing/v1.ts index 39e7ff1b740..3cd43934243 100644 --- a/src/apis/testing/v1.ts +++ b/src/apis/testing/v1.ts @@ -844,7 +844,7 @@ export namespace testing_v1 { */ export interface Schema$ManualSharding { /** - * Required. Group of packages, classes, and/or test methods to be run for each shard. The number of shard_test_targets must be > 1, and <= 50. + * Required. Group of packages, classes, and/or test methods to be run for each shard. The number of shard_test_targets must be >= 1 and <= 50. */ testTargetsForShard?: Schema$TestTargetsForShard[]; } @@ -1315,7 +1315,7 @@ export namespace testing_v1 { */ export interface Schema$UniformSharding { /** - * Required. Total number of shards. The number must be > 1, and <= 50. + * Required. Total number of shards. The number must be >= 1 and <= 50. */ numShards?: number | null; } diff --git a/src/apis/toolresults/README.md b/src/apis/toolresults/README.md index f7b53cffffb..4e702d00401 100644 --- a/src/apis/toolresults/README.md +++ b/src/apis/toolresults/README.md @@ -2,7 +2,7 @@ # toolresults -> Reads and publishes results from Firebase Test Lab. +> API to publish and access results from developer tools. ## Installation diff --git a/src/apis/toolresults/index.ts b/src/apis/toolresults/index.ts index 99b7036c5e0..70640d2976d 100644 --- a/src/apis/toolresults/index.ts +++ b/src/apis/toolresults/index.ts @@ -14,21 +14,33 @@ /*! THIS FILE IS AUTO-GENERATED */ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; +import {toolresults_v1} from './v1'; import {toolresults_v1beta3} from './v1beta3'; export const VERSIONS = { + v1: toolresults_v1.Toolresults, v1beta3: toolresults_v1beta3.Toolresults, }; +export function toolresults(version: 'v1'): toolresults_v1.Toolresults; +export function toolresults( + options: toolresults_v1.Options +): toolresults_v1.Toolresults; export function toolresults( version: 'v1beta3' ): toolresults_v1beta3.Toolresults; export function toolresults( options: toolresults_v1beta3.Options ): toolresults_v1beta3.Toolresults; -export function toolresults( +export function toolresults< + T = toolresults_v1.Toolresults | toolresults_v1beta3.Toolresults +>( this: GoogleConfigurable, - versionOrOptions: 'v1beta3' | toolresults_v1beta3.Options + versionOrOptions: + | 'v1' + | toolresults_v1.Options + | 'v1beta3' + | toolresults_v1beta3.Options ) { return getAPI('toolresults', versionOrOptions, VERSIONS, this); } diff --git a/src/apis/toolresults/v1.ts b/src/apis/toolresults/v1.ts new file mode 100644 index 00000000000..280449dae6d --- /dev/null +++ b/src/apis/toolresults/v1.ts @@ -0,0 +1,429 @@ +// Copyright 2019 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, +} from 'google-auth-library'; +import { + GoogleConfigurable, + createAPIRequest, + MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace toolresults_v1 { + export interface Options extends GlobalOptions { + version: 'v1'; + } + + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * Cloud Tool Results API + * + * API to publish and access results from developer tools. + * + * @example + * const {google} = require('googleapis'); + * const toolresults = google.toolresults('v1'); + * + * @namespace toolresults + * @type {Function} + * @version v1 + * @variation v1 + * @param {object=} options Options for Toolresults + */ + export class Toolresults { + context: APIRequestContext; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + } + } + + /** + * Additional details for an ANR crash. + */ + export interface Schema$ANR { + /** + * The stack trace of the ANR crash. Optional. + */ + stackTrace?: Schema$StackTrace; + } + /** + * A suggestion to use deep links for a Robo run. + */ + export interface Schema$AvailableDeepLinks {} + /** + * A warning that Robo encountered a screen that was mostly blank; this may indicate a problem with the app. + */ + export interface Schema$BlankScreen { + /** + * The screen id of the element + */ + screenId?: string | null; + } + /** + * Crash dialog was detected during the test execution + */ + export interface Schema$CrashDialogError { + /** + * The name of the package that caused the dialog. + */ + crashPackage?: string | null; + } + /** + * Additional details about encountered login screens. + */ + export interface Schema$EncounteredLoginScreen { + /** + * Number of encountered distinct login screens. + */ + distinctScreens?: number | null; + /** + * Subset of login screens. + */ + screenIds?: string[] | null; + } + /** + * Additional details about encountered screens with elements that are not Android UI widgets. + */ + export interface Schema$EncounteredNonAndroidUiWidgetScreen { + /** + * Number of encountered distinct screens with non Android UI widgets. + */ + distinctScreens?: number | null; + /** + * Subset of screens which contain non Android UI widgets. + */ + screenIds?: string[] | null; + } + /** + * Failed to install the APK. + */ + export interface Schema$FailedToInstall {} + /** + * Additional details for a fatal exception. + */ + export interface Schema$FatalException { + /** + * The stack trace of the fatal exception. Optional. + */ + stackTrace?: Schema$StackTrace; + } + /** + * Additional details of in-app purchases encountered during the crawl. + */ + export interface Schema$InAppPurchasesFound { + /** + * The total number of in-app purchases flows explored: how many times the robo tries to buy a SKU. + */ + inAppPurchasesFlowsExplored?: number | null; + /** + * The total number of in-app purchases flows started. + */ + inAppPurchasesFlowsStarted?: number | null; + } + /** + * A warning that Robo did not crawl potentially important parts of the app. + */ + export interface Schema$InsufficientCoverage {} + /** + * Additional details for an iOS app crash. + */ + export interface Schema$IosAppCrashed { + /** + * The stack trace, if one is available. Optional. + */ + stackTrace?: Schema$StackTrace; + } + /** + * Failed to find the launcher activity of an app. + */ + export interface Schema$LauncherActivityNotFound {} + /** + * Additional details for a native crash. + */ + export interface Schema$NativeCrash { + /** + * The stack trace of the native crash. Optional. + */ + stackTrace?: Schema$StackTrace; + } + /** + * A non-sdk API and examples of it being called along with other metadata See https://developer.android.com/distribute/best-practices/develop/restrictions-non-sdk-interfaces + */ + export interface Schema$NonSdkApi { + /** + * The signature of the Non-SDK API + */ + apiSignature?: string | null; + /** + * Example stack traces of this API being called. + */ + exampleStackTraces?: string[] | null; + /** + * Optional debugging insights for non-SDK API violations. + */ + insights?: Schema$NonSdkApiInsight[]; + /** + * The total number of times this API was observed to have been called. + */ + invocationCount?: number | null; + /** + * Which list this API appears on + */ + list?: string | null; + } + /** + * Non-SDK API insights (to address debugging solutions). + */ + export interface Schema$NonSdkApiInsight { + /** + * Optional sample stack traces, for which this insight applies (there should be at least one). + */ + exampleTraceMessages?: string[] | null; + /** + * A unique ID, to be used for determining the effectiveness of this particular insight in the context of a matcher. (required) + */ + matcherId?: string | null; + /** + * An insight indicating that the hidden API usage originates from a Google-provided library. + */ + pendingGoogleUpdateInsight?: Schema$PendingGoogleUpdateInsight; + /** + * An insight indicating that the hidden API usage originates from the use of a library that needs to be upgraded. + */ + upgradeInsight?: Schema$UpgradeInsight; + } + /** + * Additional details for a non-sdk API usage violation. + */ + export interface Schema$NonSdkApiUsageViolation { + /** + * Signatures of a subset of those hidden API's. + */ + apiSignatures?: string[] | null; + /** + * Total number of unique hidden API's accessed. + */ + uniqueApis?: number | null; + } + /** + * Contains a summary and examples of non-sdk API usage violations. + */ + export interface Schema$NonSdkApiUsageViolationReport { + /** + * Examples of the detected API usages. + */ + exampleApis?: Schema$NonSdkApi[]; + /** + * Minimum API level required for the application to run. + */ + minSdkVersion?: number | null; + /** + * Specifies the API Level on which the application is designed to run. + */ + targetSdkVersion?: number | null; + /** + * Total number of unique Non-SDK API's accessed. + */ + uniqueApis?: number | null; + } + /** + * A warning that Robo encountered a screen that has overlapping clickable elements; this may indicate a potential UI issue. + */ + export interface Schema$OverlappingUIElements { + /** + * Resource names of the overlapping screen elements + */ + resourceName?: string[] | null; + /** + * The screen id of the elements + */ + screenId?: string | null; + } + /** + * This insight indicates that the hidden API usage originates from a Google-provided library. Users need not take any action. + */ + export interface Schema$PendingGoogleUpdateInsight { + /** + * The name of the Google-provided library with the non-SDK API dependency. + */ + nameOfGoogleLibrary?: string | null; + } + /** + * A notification that Robo signed in with Google. + */ + export interface Schema$PerformedGoogleLogin {} + /** + * A notification that Robo performed some monkey actions. + */ + export interface Schema$PerformedMonkeyActions { + /** + * The total number of monkey actions performed during the crawl. + */ + totalActions?: number | null; + } + /** + * Execution stats for a user-provided Robo script. + */ + export interface Schema$RoboScriptExecution { + /** + * The number of Robo script actions executed successfully. + */ + successfulActions?: number | null; + /** + * The total number of actions in the Robo script. + */ + totalActions?: number | null; + } + /** + * A stacktrace. + */ + export interface Schema$StackTrace { + /** + * The stack trace message. Required + */ + exception?: string | null; + } + /** + * User provided intent failed to resolve to an activity. + */ + export interface Schema$StartActivityNotFound { + action?: string | null; + uri?: string | null; + } + /** + * A warning that the screen hierarchy is deeper than the recommended threshold. + */ + export interface Schema$UIElementTooDeep { + /** + * The depth of the screen element + */ + depth?: number | null; + /** + * The screen id of the element + */ + screenId?: string | null; + /** + * The screen state id of the element + */ + screenStateId?: string | null; + } + /** + * Default unspecified warning. + */ + export interface Schema$UnspecifiedWarning {} + /** + * Additional details of an unused robodirective. + */ + export interface Schema$UnusedRoboDirective { + /** + * The name of the resource that was unused. + */ + resourceName?: string | null; + } + /** + * This insight is a recommendation to upgrade a given library to the specified version, in order to avoid dependencies on non-SDK APIs. + */ + export interface Schema$UpgradeInsight { + /** + * The name of the package to be upgraded. + */ + packageName?: string | null; + /** + * The suggested version to upgrade to. Optional: In case we are not sure which version solves this problem + */ + upgradeToVersion?: string | null; + } + /** + * Additional details of a used Robo directive. + */ + export interface Schema$UsedRoboDirective { + /** + * The name of the resource that was used. + */ + resourceName?: string | null; + } + /** + * Additional details of a used Robo directive with an ignore action. Note: This is a different scenario than unused directive. + */ + export interface Schema$UsedRoboIgnoreDirective { + /** + * The name of the resource that was ignored. + */ + resourceName?: string | null; + } +} diff --git a/src/apis/toolresults/v1beta3.ts b/src/apis/toolresults/v1beta3.ts index 36d1c4ac865..f97b49b84c6 100644 --- a/src/apis/toolresults/v1beta3.ts +++ b/src/apis/toolresults/v1beta3.ts @@ -257,6 +257,59 @@ export namespace toolresults_v1beta3 { */ seconds?: string | null; } + /** + * An Environment represents the set of test runs (Steps) from the parent Execution that are configured with the same set of dimensions (Model, Version, Locale, and Orientation). Multiple such runs occur particularly because of features like sharding (splitting up a test suite to run in parallel across devices) and reruns (running a test multiple times to check for different outcomes). + */ + export interface Schema$Environment { + /** + * Output only. The time when the Environment status was set to complete. This value will be set automatically when state transitions to COMPLETE. + */ + completionTime?: Schema$Timestamp; + /** + * Output only. The time when the Environment was created. + */ + creationTime?: Schema$Timestamp; + /** + * Dimension values describing the environment. Dimension values always consist of "Model", "Version", "Locale", and "Orientation". - In response: always set - In create request: always set - In update request: never set + */ + dimensionValue?: Schema$EnvironmentDimensionValueEntry[]; + /** + * A short human-readable name to display in the UI. Maximum of 100 characters. For example: Nexus 5, API 27. + */ + displayName?: string | null; + /** + * Output only. An Environment id. + */ + environmentId?: string | null; + /** + * Merged result of the environment. + */ + environmentResult?: Schema$MergedResult; + /** + * Output only. An Execution id. + */ + executionId?: string | null; + /** + * Output only. A History id. + */ + historyId?: string | null; + /** + * Output only. A Project id. + */ + projectId?: string | null; + /** + * The location where output files are stored in the user bucket. + */ + resultsStorage?: Schema$ResultsStorage; + /** + * Output only. Summaries of shards. Only one shard will present unless sharding feature is enabled in TestExecutionService. + */ + shardSummaries?: Schema$ShardSummary[]; + } + export interface Schema$EnvironmentDimensionValueEntry { + key?: string | null; + value?: string | null; + } /** * An Execution represents a collection of Steps. For instance, it could represent: - a mobile test executed across a range of device configurations - a jenkins job with a build step followed by a test step The maximum size of an execution message is 1 MiB. An Execution can be updated until its state is set to COMPLETE at which point it becomes immutable. */ @@ -457,6 +510,31 @@ export namespace toolresults_v1beta3 { runDuration?: Schema$Duration; stepId?: string | null; } + /** + * Response message for EnvironmentService.ListEnvironments. + */ + export interface Schema$ListEnvironmentsResponse { + /** + * Environments. Always set. + */ + environments?: Schema$Environment[]; + /** + * A Execution id Always set. + */ + executionId?: string | null; + /** + * A History id. Always set. + */ + historyId?: string | null; + /** + * A continuation token to resume the query at the next item. Will only be set if there are more Environments to fetch. + */ + nextPageToken?: string | null; + /** + * A Project id. Always set. + */ + projectId?: string | null; + } export interface Schema$ListExecutionsResponse { /** * Executions. Always set. @@ -545,6 +623,23 @@ export namespace toolresults_v1beta3 { */ memoryTotalInKibibyte?: string | null; } + /** + * Merged test result for environment. If the environment has only one step (no reruns or shards), then the merged result is the same as the step result. If the environment has multiple shards and/or reruns, then the results of shards and reruns that belong to the same environment are merged into one environment result. + */ + export interface Schema$MergedResult { + /** + * Outcome of the resource + */ + outcome?: Schema$Outcome; + /** + * State of the resource + */ + state?: string | null; + /** + * The combined and rolled-up result of each test suite that was run as part of this environment. Combining: When the test cases from a suite are run in different steps (sharding), the results are added back together in one overview. (e.g., if shard1 has 2 failures and shard2 has 1 failure than the overview failure_count = 3). Rollup: When test cases from the same suite are run multiple times (flaky), the results are combined (e.g., if testcase1.run1 fails, testcase1.run2 passes, and both testcase2.run1 and testcase2.run2 fail then the overview flaky_count = 1 and failure_count = 1). + */ + testSuiteOverviews?: Schema$TestSuiteOverview[]; + } /** * Details when multiple steps are run with the same configuration as a group. */ @@ -711,6 +806,19 @@ export namespace toolresults_v1beta3 { */ xunitXmlFiles?: Schema$FileReference[]; } + /** + * The storage for test results. + */ + export interface Schema$ResultsStorage { + /** + * The root directory for test results. + */ + resultsStoragePath?: Schema$FileReference; + /** + * The path to the Xunit XML file. + */ + xunitXmlFile?: Schema$FileReference; + } export interface Schema$Screen { /** * File reference of the png file. Required. @@ -747,6 +855,15 @@ export namespace toolresults_v1beta3 { */ screens?: Schema$Screen[]; } + /** + * Result summary for a shard in an environment. + */ + export interface Schema$ShardSummary { + /** + * Merged result of the shard. + */ + shardResult?: Schema$MergedResult; + } /** * Details for an outcome with a SKIPPED outcome summary. */ @@ -873,7 +990,7 @@ export namespace toolresults_v1beta3 { value?: string | null; } /** - * Details for an outcome with a SUCCESS outcome summary. + * Details for an outcome with a SUCCESS outcome summary. LINT.IfChange */ export interface Schema$SuccessDetail { /** @@ -1002,6 +1119,10 @@ export namespace toolresults_v1beta3 { * Number of failed test cases, typically set by the service by parsing the xml_source. May also be set by the user. - In create/response: always set - In update request: never */ failureCount?: number | null; + /** + * Number of flaky test cases, set by the service by rolling up flaky test attempts. Present only for rollup test suite overview at environment level. A step cannot have flaky test cases. + */ + flakyCount?: number | null; /** * The name of the test suite. - In create/response: always set - In update request: never */ @@ -1602,12 +1723,16 @@ export namespace toolresults_v1beta3 { export class Resource$Projects$Histories$Executions { context: APIRequestContext; clusters: Resource$Projects$Histories$Executions$Clusters; + environments: Resource$Projects$Histories$Executions$Environments; steps: Resource$Projects$Histories$Executions$Steps; constructor(context: APIRequestContext) { this.context = context; this.clusters = new Resource$Projects$Histories$Executions$Clusters( this.context ); + this.environments = new Resource$Projects$Histories$Executions$Environments( + this.context + ); this.steps = new Resource$Projects$Histories$Executions$Steps( this.context ); @@ -2237,6 +2362,228 @@ export namespace toolresults_v1beta3 { projectId?: string; } + export class Resource$Projects$Histories$Executions$Environments { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * toolresults.projects.histories.executions.environments.get + * @desc Gets an Environment. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Environment does not exist + * @alias toolresults.projects.histories.executions.environments.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.environmentId Required. An Environment id. + * @param {string} params.executionId Required. An Execution id. + * @param {string} params.historyId Required. A History id. + * @param {string} params.projectId Required. A Project id. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Projects$Histories$Executions$Environments$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Histories$Executions$Environments$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Histories$Executions$Environments$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Histories$Executions$Environments$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Histories$Executions$Environments$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Histories$Executions$Environments$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/environments/{environmentId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: [ + 'projectId', + 'historyId', + 'executionId', + 'environmentId', + ], + pathParams: ['environmentId', 'executionId', 'historyId', 'projectId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * toolresults.projects.histories.executions.environments.list + * @desc Lists Environments for a given Execution. The Environments are sorted by display name. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing Execution does not exist + * @alias toolresults.projects.histories.executions.environments.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.executionId Required. An Execution id. + * @param {string} params.historyId Required. A History id. + * @param {integer=} params.pageSize The maximum number of Environments to fetch. Default value: 25. The server will use this default if the field is not set or has a value of 0. + * @param {string=} params.pageToken A continuation token to resume the query at the next item. + * @param {string} params.projectId Required. A Project id. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$Histories$Executions$Environments$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Histories$Executions$Environments$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Histories$Executions$Environments$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Histories$Executions$Environments$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Histories$Executions$Environments$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Histories$Executions$Environments$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/environments' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['projectId', 'historyId', 'executionId'], + pathParams: ['executionId', 'historyId', 'projectId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Histories$Executions$Environments$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. An Environment id. + */ + environmentId?: string; + /** + * Required. An Execution id. + */ + executionId?: string; + /** + * Required. A History id. + */ + historyId?: string; + /** + * Required. A Project id. + */ + projectId?: string; + } + export interface Params$Resource$Projects$Histories$Executions$Environments$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. An Execution id. + */ + executionId?: string; + /** + * Required. A History id. + */ + historyId?: string; + /** + * The maximum number of Environments to fetch. Default value: 25. The server will use this default if the field is not set or has a value of 0. + */ + pageSize?: number; + /** + * A continuation token to resume the query at the next item. + */ + pageToken?: string; + /** + * Required. A Project id. + */ + projectId?: string; + } + export class Resource$Projects$Histories$Executions$Steps { context: APIRequestContext; perfMetricsSummary: Resource$Projects$Histories$Executions$Steps$Perfmetricssummary; diff --git a/src/apis/vision/v1.ts b/src/apis/vision/v1.ts index be8565a3255..37add774d7f 100644 --- a/src/apis/vision/v1.ts +++ b/src/apis/vision/v1.ts @@ -9171,7 +9171,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. Resource name of the ProductSet to get. Format is: `projects/PROJECT_ID/locations/LOG_ID/productSets/PRODUCT_SET_ID` + * @param {string} params.name Required. Resource name of the ProductSet to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -9807,7 +9807,7 @@ export namespace vision_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Resource name of the ProductSet to get. Format is: `projects/PROJECT_ID/locations/LOG_ID/productSets/PRODUCT_SET_ID` + * Required. Resource name of the ProductSet to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` */ name?: string; } diff --git a/src/apis/websecurityscanner/v1.ts b/src/apis/websecurityscanner/v1.ts index 16fb5767766..92a2a47f9ce 100644 --- a/src/apis/websecurityscanner/v1.ts +++ b/src/apis/websecurityscanner/v1.ts @@ -127,6 +127,10 @@ export namespace websecurityscanner_v1 { * Authentication using a Google account. */ googleAccount?: Schema$GoogleAccount; + /** + * Authentication using Identity-Aware-Proxy (IAP). + */ + iapCredential?: Schema$IapCredential; } /** * A CrawledUrl resource represents a URL that was crawled during a ScanRun. Web Security Scanner Service crawls the web applications, following all links within the scope of sites, to find the URLs to test against. @@ -287,6 +291,24 @@ export namespace websecurityscanner_v1 { */ value?: string | null; } + /** + * Describes authentication configuration for Identity-Aware-Proxy (IAP). + */ + export interface Schema$IapCredential { + /** + * Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies. + */ + iapTestServiceAccountInfo?: Schema$IapTestServiceAccountInfo; + } + /** + * Describes authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies. + */ + export interface Schema$IapTestServiceAccountInfo { + /** + * Required. Describes OAuth2 client id of resources protected by Identity-Aware-Proxy (IAP). + */ + targetAudienceClientId?: string | null; + } /** * Response for the `ListCrawledUrls` method. */ @@ -385,6 +407,10 @@ export namespace websecurityscanner_v1 { * Controls export of scan configurations and results to Cloud Security Command Center. */ exportToSecurityCommandCenter?: string | null; + /** + * Whether the scan config is managed by Cloud Web Security Scanner, output only. + */ + managedScan?: boolean | null; /** * The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error. */ @@ -405,6 +431,10 @@ export namespace websecurityscanner_v1 { * Required. The starting URLs from which the scanner finds site pages. */ startingUrls?: string[] | null; + /** + * Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses. + */ + staticIpScan?: boolean | null; /** * The user agent used during scanning. */ diff --git a/src/apis/websecurityscanner/v1beta.ts b/src/apis/websecurityscanner/v1beta.ts index 1d95d72af80..72464061914 100644 --- a/src/apis/websecurityscanner/v1beta.ts +++ b/src/apis/websecurityscanner/v1beta.ts @@ -127,6 +127,10 @@ export namespace websecurityscanner_v1beta { * Authentication using a Google account. */ googleAccount?: Schema$GoogleAccount; + /** + * Authentication using Identity-Aware-Proxy (IAP). + */ + iapCredential?: Schema$IapCredential; } /** * A CrawledUrl resource represents a URL that was crawled during a ScanRun. Web Security Scanner Service crawls the web applications, following all links within the scope of sites, to find the URLs to test against. @@ -287,6 +291,24 @@ export namespace websecurityscanner_v1beta { */ value?: string | null; } + /** + * Describes authentication configuration for Identity-Aware-Proxy (IAP). + */ + export interface Schema$IapCredential { + /** + * Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies. + */ + iapTestServiceAccountInfo?: Schema$IapTestServiceAccountInfo; + } + /** + * Describes authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies. + */ + export interface Schema$IapTestServiceAccountInfo { + /** + * Required. Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP). + */ + targetAudienceClientId?: string | null; + } /** * Response for the `ListCrawledUrls` method. */ @@ -389,6 +411,10 @@ export namespace websecurityscanner_v1beta { * Latest ScanRun if available. */ latestRun?: Schema$ScanRun; + /** + * Whether the scan config is managed by Cloud Web Security Scanner, output only. + */ + managedScan?: boolean | null; /** * The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error. */ @@ -409,6 +435,10 @@ export namespace websecurityscanner_v1beta { * Required. The starting URLs from which the scanner finds site pages. */ startingUrls?: string[] | null; + /** + * Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses. + */ + staticIpScan?: boolean | null; /** * Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be used as a default. */ diff --git a/src/apis/youtube/v3.ts b/src/apis/youtube/v3.ts index 9ee0fa212f8..8599081bdd0 100644 --- a/src/apis/youtube/v3.ts +++ b/src/apis/youtube/v3.ts @@ -1085,10 +1085,12 @@ export namespace youtube_v3 { * The long uploads status of this channel. See */ longUploadsStatus?: string | null; + madeForKids?: boolean | null; /** * Privacy status of the channel. */ privacyStatus?: string | null; + selfDeclaredMadeForKids?: boolean | null; } /** * Freebase topic information related to the channel. @@ -2151,6 +2153,7 @@ export namespace youtube_v3 { * Priority of the live broadcast event (internal state). */ liveBroadcastPriority?: string | null; + madeForKids?: boolean | null; /** * The broadcast's privacy status. Note that the broadcast represents exactly one YouTube video, so the privacy settings are identical to those supported for videos. In addition, you can set this field by modifying the broadcast resource or by setting the privacyStatus field of the corresponding video resource. */ @@ -2159,6 +2162,7 @@ export namespace youtube_v3 { * The broadcast's recording status. */ recordingStatus?: string | null; + selfDeclaredMadeForKids?: boolean | null; } /** * A liveChatBan resource represents a ban for a YouTube live chat. @@ -2680,10 +2684,6 @@ export namespace youtube_v3 { * Etag of this resource. */ etag?: string | null; - /** - * The ID that YouTube assigns to uniquely identify the member. - */ - id?: string | null; /** * Identifies what kind of resource this is. Value: the fixed string "youtube#member". */ @@ -2723,9 +2723,17 @@ export namespace youtube_v3 { } export interface Schema$MembershipsDetails { /** - * All levels that the user has access to. This includes the purchased level and all other levels that are included because of a higher purchase. + * All levels that the user has access to. This includes the currently active level and all other levels that are included because of a higher purchase. */ accessibleLevels?: string[] | null; + /** + * The highest level that the user has access to at the moment. + */ + highestAccessibleLevel?: string | null; + /** + * Display name for the highest level that the user has access to at the moment. + */ + highestAccessibleLevelDisplayName?: string | null; /** * The date and time when the user became a continuous member across all levels. */ @@ -2743,7 +2751,7 @@ export namespace youtube_v3 { */ memberTotalDurationCurrentLevel?: number | null; /** - * The highest level the user has access to at the moment. + * The highest level that the user has access to at the moment. DEPRECATED - highest_accessible_level should be used instead. This will be removed after we make sure there are no 3rd parties relying on it. */ purchasedLevel?: string | null; } @@ -4370,6 +4378,7 @@ export namespace youtube_v3 { * The video's license. */ license?: string | null; + madeForKids?: boolean | null; /** * The video's privacy status. */ @@ -4386,6 +4395,10 @@ export namespace youtube_v3 { * This value explains why YouTube rejected an uploaded video. This property is only present if the uploadStatus property indicates that the upload was rejected. */ rejectionReason?: string | null; + /** + * Allows clients to set the Crosswalk self_declared state for a Video. This maps to VAPI.Video.creator_flags.is_crosswalk_self_declared() and VAPI.Video.creator_flags.is_not_crosswalk_self_declared(). + */ + selfDeclaredMadeForKids?: boolean | null; /** * The status of the uploaded video. */ @@ -9209,11 +9222,12 @@ export namespace youtube_v3 { * @memberOf! () * * @param {object} params Parameters for request + * @param {string=} params.filterByMemberChannelId The filterByMemberChannelId parameter represents a comma separated list of channel IDs. Only data about members that are part of this list will be included in the response. It can be used to efficiently check whether specific users are entitled to perks offered via third parties. * @param {string=} params.hasAccessToLevel The hasAccessToLevel parameter specifies, when set, the ID of a pricing level that members from the results set should have access to. When not set, all members will be considered, regardless of their active pricing level. * @param {integer=} params.maxResults The maxResults parameter specifies the maximum number of items that should be returned in the result set. * @param {string=} params.mode The mode parameter specifies which channel members to return. * @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 and prevPageToken properties identify other pages that could be retrieved. - * @param {string} params.part The part parameter specifies the member resource parts that the API response will include. Supported values are id and snippet. + * @param {string} params.part The part parameter specifies the member resource parts that the API response will include. Set the parameter value to snippet. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -9286,6 +9300,10 @@ export namespace youtube_v3 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * The filterByMemberChannelId parameter represents a comma separated list of channel IDs. Only data about members that are part of this list will be included in the response. It can be used to efficiently check whether specific users are entitled to perks offered via third parties. + */ + filterByMemberChannelId?: string; /** * The hasAccessToLevel parameter specifies, when set, the ID of a pricing level that members from the results set should have access to. When not set, all members will be considered, regardless of their active pricing level. */ @@ -9303,7 +9321,7 @@ export namespace youtube_v3 { */ pageToken?: string; /** - * The part parameter specifies the member resource parts that the API response will include. Supported values are id and snippet. + * The part parameter specifies the member resource parts that the API response will include. Set the parameter value to snippet. */ part?: string; } diff --git a/src/generator/templates/package.json.njk b/src/generator/templates/package.json.njk index 23fb2311985..d7a476f85bb 100644 --- a/src/generator/templates/package.json.njk +++ b/src/generator/templates/package.json.njk @@ -35,7 +35,7 @@ "gts": "^1.0.0", "null-loader": "^3.0.0", "ts-loader": "^6.0.4", - "typedoc": "^0.15.0", + "typedoc": "^0.16.0", "typescript": "~3.7.0", "webpack": "^4.35.3", "webpack-cli": "^3.3.5" diff --git a/src/index.ts b/src/index.ts index 63d70a6f868..3c457e2aa2d 100644 --- a/src/index.ts +++ b/src/index.ts @@ -120,6 +120,7 @@ export {datastore_v1beta3} from './apis/datastore/v1beta3'; export {deploymentmanager_alpha} from './apis/deploymentmanager/alpha'; export {deploymentmanager_v2} from './apis/deploymentmanager/v2'; export {deploymentmanager_v2beta} from './apis/deploymentmanager/v2beta'; +export {dfareporting_v3_3} from './apis/dfareporting/v3.3'; export {dfareporting_v3_4} from './apis/dfareporting/v3.4'; export {dialogflow_v2} from './apis/dialogflow/v2'; export {dialogflow_v2beta1} from './apis/dialogflow/v2beta1'; @@ -149,8 +150,6 @@ export {firestore_v1} from './apis/firestore/v1'; export {firestore_v1beta1} from './apis/firestore/v1beta1'; export {firestore_v1beta2} from './apis/firestore/v1beta2'; export {fitness_v1} from './apis/fitness/v1'; -export {fusiontables_v1} from './apis/fusiontables/v1'; -export {fusiontables_v2} from './apis/fusiontables/v2'; export {games_v1} from './apis/games/v1'; export {gamesConfiguration_v1configuration} from './apis/gamesConfiguration/v1configuration'; export {gamesManagement_v1management} from './apis/gamesManagement/v1management'; @@ -197,8 +196,10 @@ export {people_v1} from './apis/people/v1'; export {playcustomapp_v1} from './apis/playcustomapp/v1'; export {plus_v1} from './apis/plus/v1'; export {plusDomains_v1} from './apis/plusDomains/v1'; +export {policytroubleshooter_v1} from './apis/policytroubleshooter/v1'; export {policytroubleshooter_v1beta} from './apis/policytroubleshooter/v1beta'; export {poly_v1} from './apis/poly/v1'; +export {prod_tt_sasportal_v1alpha1} from './apis/prod_tt_sasportal/v1alpha1'; export {proximitybeacon_v1beta1} from './apis/proximitybeacon/v1beta1'; export {pubsub_v1} from './apis/pubsub/v1'; export {pubsub_v1beta1a} from './apis/pubsub/v1beta1a'; @@ -217,11 +218,13 @@ export {run_v1beta1} from './apis/run/v1beta1'; export {runtimeconfig_v1} from './apis/runtimeconfig/v1'; export {runtimeconfig_v1beta1} from './apis/runtimeconfig/v1beta1'; export {safebrowsing_v4} from './apis/safebrowsing/v4'; +export {sasportal_v1alpha1} from './apis/sasportal/v1alpha1'; export {script_v1} from './apis/script/v1'; -export {searchconsole_v1} from './apis/searchconsole/v1'; +export {secretmanager_v1beta1} from './apis/secretmanager/v1beta1'; export {securitycenter_v1} from './apis/securitycenter/v1'; export {securitycenter_v1beta1} from './apis/securitycenter/v1beta1'; export {securitycenter_v1p1alpha1} from './apis/securitycenter/v1p1alpha1'; +export {securitycenter_v1p1beta1} from './apis/securitycenter/v1p1beta1'; export {servicebroker_v1} from './apis/servicebroker/v1'; export {servicebroker_v1alpha1} from './apis/servicebroker/v1alpha1'; export {servicebroker_v1beta1} from './apis/servicebroker/v1beta1'; @@ -245,13 +248,13 @@ export {storage_v1} from './apis/storage/v1'; export {storage_v1beta2} from './apis/storage/v1beta2'; export {storagetransfer_v1} from './apis/storagetransfer/v1'; export {streetviewpublish_v1} from './apis/streetviewpublish/v1'; -export {surveys_v2} from './apis/surveys/v2'; export {tagmanager_v1} from './apis/tagmanager/v1'; export {tagmanager_v2} from './apis/tagmanager/v2'; export {tasks_v1} from './apis/tasks/v1'; export {testing_v1} from './apis/testing/v1'; export {texttospeech_v1} from './apis/texttospeech/v1'; export {texttospeech_v1beta1} from './apis/texttospeech/v1beta1'; +export {toolresults_v1} from './apis/toolresults/v1'; export {toolresults_v1beta3} from './apis/toolresults/v1beta3'; export {tpu_v1} from './apis/tpu/v1'; export {tpu_v1alpha1} from './apis/tpu/v1alpha1';